Help Docs

Manpages and Markdown files give your users easy-to-read references for your project's CLI inputs.

Configuration

Help Docs are configured with the cova.generate.HelpDocsConfig struct which can be set up directly in the Meta Doc Config using the cova.generate.MetaDocConfig.help_docs_config field. Within the Config, there are self-explanatory fields for configuring the following categories:

• Generated Filepath
• Recursive Parsing Settings
• Project Info
• Manpage Specific Info
• Manpage Format Strings
• Markdown Format Strings

For more info on the specifics of creating and formatting Manpage and Markdown files, see following resources:

• Manpages Tutorial
• Manpages Official Manpage
• Markdown Tutorial

Installation & Usage

Manpages

Manpages are largely meant for Unix systems. Installing them to a system is as simple as:

1. Copy or Symlink the Manpage file(s) to the correct section under either /usr/local/share/man/ (preferred) or /usr/share/man/.
2. Run sudo mandb to update your Manpage Database.
3. Run man [manpage_file] to try it out!

More info here.

Markdown

Markdown files generated by Cova can be a great starting point for, or addition to, a project's README.md. They can also be used as reference materials for guides, similar to this wiki. If you'd like to learn more about creating GitHub Wikis, click here.