Download the PHP package lorenzschaef/help-pages-bundle without Composer
On this page you can find all versions of the php package lorenzschaef/help-pages-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lorenzschaef/help-pages-bundle
More information about lorenzschaef/help-pages-bundle
Files in lorenzschaef/help-pages-bundle
Package help-pages-bundle
Short Description This Bundle provides a simple way of including end user documentation in your application.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package help-pages-bundle
HelpPagesBundle
This is a Symfony Bundle that provides a simple way of including end user documentation in your application. It takes markdown files stored on the server and renders them in a template, together with an automatically generated menu.
Installation
Step 1: Download the Bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.
Step 2: Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles
in the app/AppKernel.php file of your project.
The bundle depends on the KnpMarkdownBundle, so you have to register that as well, if you haven't already.
Step 3: Configure the Routes
Add the following line to your app/config/routing.yml and change the prefix as you like.
Step 4: Add the Bundle to the Assetic Configuration
In your app/config/config.yml add the Bundle to the Assetic config.
Step 4: Change the Base Directory (optional)
By default, the bundle looks for your Help Pages in app/Resources/HelpPages. You can change this in your config like so:
The directory is specified relative to your AppKernel.php, which normally resides in the app folder.
Usage
Add your Documents
Put your Help Pages in the configured folder (app/Resources/HelpPages by default). The files have to end with .md and can be organized in subfolders. To define the sorting order, you may prepend a number followed by an underscore to the filename.
These pages can then be accessed through the following URLs:
The menu generator looks for the first level one title of each document to display it as the link text. Currently only the syntax with the hash (#) is supported. If it can't find any level 1 title in the document, it will use the string "Untitled".
Change the Appearance
The original templates are located in the bundle folder under Resources/views.
- layout.html.twig: defines the general layout.
- toc.html.twig: defines a twig macro that renders the table of contents which is used in layout.html.twig
In order to override one of these, just put a template with the same name in app/Resources/LorenzschaefHelpPagesBundle/views.
All versions of help-pages-bundle with dependencies
knplabs/knp-markdown-bundle Version ^1.4
symfony/framework-bundle Version ~2.3
symfony/twig-bundle Version ~2.3