NSClient++ documentation
HTML CMake
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
custom_theme
docs
samples
source
.gitignore
CMakeLists.txt
README.md
mkdocs.yml

README.md

NSClient++ documentation

Index

About documentation

The NSClient++ documentation is written in GitHub flavored Markdown. It is located in the docs/ directory and can be edited with your preferred editor. You can also edit it online on GitHub.

vim docs/installing.md

In order to review and test changes, you can install the mkdocs Python library.

pip install mkdocs

Note: Use at least 0.16, 0.14 has this bug.

This allows you to start a local mkdocs viewer instance on http://localhost:8000

mkdocs serve

Changes on the chapter layout can be done inside the mkdocs.yml file in the main tree.