yaml-doc
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

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:

Examples of output:

yaml-doc is available as npm package.

npm i yaml-doc

Project license is MIT.

Readme

Keywords

none

Package Sidebar

Install

npm i yaml-doc

Weekly Downloads

1

Version

0.1.0

License

MIT

Unpacked Size

156 kB

Total Files

56

Last publish

Collaborators

  • enepomnyaschih