Documentation

Documentation is written in plain-text Markdown format.

Jekyll then transforms the Markdown source into a static web site.

Contributing

Your help in extending and correcting this documentation is quite welcome.

When writing or maintaing documentation, please keep in mind:

• All documentation files are in the docs dir, with an .md extension.
• Links in markdown files are relative. The goal is that links work both when the markdown is being browsed directly on GitHub and in the generated Jekyll site.
• Please put a title: frontmatter at the top of every file. If you’re not familiar, frontmatter is a fancy way of referring to this:

---
title: 'how to use Program X'
order: 1
---

• The order directive above is used to set the ordering of your document in the left sidebar of the web page. A higher value is higher placement.

Previewing Docs Locally

To build the documentation and preview it locally:

make
bundle exec jekyll serve

man Pages

man pages are also written in Markdown, then run through md2man by the build system, to generate troff for install on target machines.

Please:

• put man pages in the man directory
• name them PAGE_NAME.md
• prefix their title frontmatter with man:
• add them to the meson build file for man pages