Download the PHP package lin3s/knowledge-base without Composer

Knowledge Base component

PHP Component to build a knowledge base from your Markup files easily.

Installation

Make sure you have composer installed in your computer.

Install the component launching the following composer command

Install a theme for your knowledge base. We use the following at LIN3S:

Add the docs in markdown format to a folder that you will later add to the config.

Integrating it in your codebase

A front controller should look like this:

You can edit as you want to match your needs

Generating the docs

LIN3S Knowledge Base, caches all the markdown files already generated in html to improve performance.

Just create a docs.php file that includes the following to generate menu and html from your markdown files:

Now just launch the following commands:

You need to create a symbolic link to match the assets url with the template you are using.

Theming

To create your own theme just create a class that implements LIN3S\KnowledgeBase\Templating\TemplateInterface and pass it as third parameter to the Configuration class used by the command and the controller.

Template rendering works together with the Loader classes. This class is responsible of fetching all required data to generate a page. The DefaultLoader generates an array with the menu tree, the document converted to html and the configuration class.

Document building

Entry point for document building is located in DocumentationBuilder class that receives a DocumentIterator and an instance of GeneratorRegistry. The first one contains the reference to all documents that need to be parsed, the second one contains all the generators required in the building process.

If you want to add a custom Generator implement GeneratorInterface and add it to the GeneratorRegistry before passing it to the DocumentationBuilder.

"Generation docs" section above, describes the whole process with code.

Licensing Options