@zambezi/ez-doc

ez-doc

The Zambezi documentation site generator is a command line tool to generate Zambezi style documentation from markdown source files, suitable for static hosting.

Installation

Install the CLI tool using npm; either globally or as a local dependency. If you're going to use ez-doc as part of your project build process, it is recommended you install it as a local dependendency:

npm install --save-dev ez-doc

Or, if you'd rather have access to ez-doc globally:

npm install -g ez-doc

Usage

To generate docs, you will need at minimum two files in your project:

• README.md
• SUMMARY.md

The former is the usual introduction to your project, but the latter – SUMMARY.md – might be new to you. It is the file that lets ez-doc know the structure of your documentation; put a list of links in there, and ez-doc will use this to extract navigation information for your documentation site. For more information, see the section on building your documentation.

Found an issue, or want to contribute?

If you find an issue, want to start a discussion on something related to this project, or have suggestions on how to improve it? Please create an issue!

See an error and want to fix it? Want to add a file or otherwise make some changes? All contributions are welcome! Please refer to the contribution guidelines for more information.

License

Please refer to the license for more information on licensing and copyright information.