The Zambezi documentation site generator is a command line tool to generate Zambezi style documentation from markdown source files.
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-docOr, if you'd rather have access to ez-doc globally:
npm install -g ez-docTo 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.