Creating Documentation

One of the goals of the LibreNMS project is to enable users to get all of the help they need from our documentation.

Writing docs

When you are adding a new feature or extension, we need to have full documentation to go along with it. It's quite simple to do this:

Please ensure you add the document to the relevant section within pages of mkdocs.yml so that it's in the correct menu and is built. Forgetting this step will result in your document never seeing the light of day :)

Formatting docs

Our docs are based on Markdown using mkdocs which adheres to markdown specs and nothing more, because of that we also import a couple of extra libraries:

This means you can use:

Markdown CheatSheet Link