emu

Simple documentation generator.

npm install emu
1 downloads in the last day
28 downloads in the last week
152 downloads in the last month

emu.js

emu is a tiny documentation generator. It does the following:

  • Parses stdin JavaScript
  • Extract comments with double asterisks
  • Trims out the prefixed whitespace
  • Prints the results to stdout

That's it.

Example

See the index.js file for an example of how emu generates its own README.md

Usage

emu < bilby.js > bilby-docs.md

Now you can process the output with something like Pandoc.

npm loves you