yaml-doc v0.1.0

yaml-doc

YAML-based software documentation generator.

This NodeJS CLI application parses YAML source files of your documentation and generates HTML documentation files based on them. The tool has been mainly designed to document library contents - in particular, TypeScript ones.

Features:

• Cascade documentation nodes:
  • Project
  • File: library module or just an article
  • Symbol: function, class, interface or value
  • Member: method or property
• Automated or manual cross-referencing between nodes.
• TypeScript-based templating engine:
  • Use Bootstrap template as a starting option.

Examples of output:

• jWidget documentation
• ts-time documentation

yaml-doc is available as npm package.

npm i yaml-doc

Project license is MIT.