endokken
Generates HTML documentation for your Atom package from AtomDoc comments.
Last updated 5 years ago by lee-dohm .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install endokken -g
SYNC missed versions from official npm registry.

Endokken Build Status Dependency Status

Generates HTML documentation for your Atom package from AtomDoc comments in your code and your GitHub project's own Markdown files.

Command-Line Interface

You can simply run the endokken command from the root directory of your Atom package and it will generate HTML documentation in the ./docs directory.

$ endokken

Endokken also supports the following command-line options:

  • --extension [EXT] Adds the given extension to all generated documentation files. Defaults to no extension for REST-like purity.
  • --metadata [FILENAME] Dumps the AtomDoc metadata to the file name you provide or api.json if no filename is given.
  • --help Displays command-line help

Acknowledgements

Endokken was originally envisioned as YARD for Atom packages. As such, Endokken owes a lot of its inspiration and ideas to YARD and its author Loren Segal.

Copyright

Copyright © 2014-2015 by Lee Dohm and Lifted Studios. See LICENSE for details.

Current Tags

  • 0.3.0                                ...           latest (5 years ago)
  • 0.2.0                                ...           v0.2.0 (5 years ago)

3 Versions

  • 0.3.0                                ...           5 years ago
  • 0.2.0                                ...           5 years ago
  • 0.1.0                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (9)
Dev Dependencies (9)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |