atomdoc-md

Markdown generator for atomdoc. Uses donna and tello.

See samples here.

Installation

Install with npm

npm install -g atomdoc-md

Examples

Generate docs

atomdoc-md generate <path to module>

Usage

Command Line

atomdoc-md generate <module>

Options:
  --doc, -o    docs directory  [default: "doc"]
  --level, -l  log level  [choices: "debug", "verbose", "info", "warn", "error"] [default: "info"]
  --template   template name  [default: "api"]
  --meta       write donna (donna.json) and tello (tello.json) metadata to doc dir
  --name, -n   generated file name  [default: "api.md"]

From Node

AtomdocMD = require 'atomdoc-md'
 
generator = new AtomdocMD( options );
generator.generateMarkdown()

Generate README.md

# From the project's root

atomdoc-md generate -o . -n README.md .

Importing Files

The default template api will include files intro.md and appendix.md into the output. The files must be located in the --doc docs directory.

API

Class	Summary
MarkdownGenerator	Generates markdown from atomdoc/tello's metadata

MarkdownGenerator_^CLASS

Generates markdown from atomdoc/tello's metadata

Methods
:: constructor( opt )	public	instance	MarkdownGenerator
opt Object Options opt.api is an Object with tello api metadata. opt.path String path to file with tello api info opt.docdir String dir to write the output to. Also looks for files to import (e.g. intro.md). opt.template String name of the template to use opt.templatePath String alternatively, path to template dir opt.modulePath String path to the module (for package.json) <p>Create a new markdown generator</p> </td>
:: generateMarkdown( )	public	instance	MarkdownGenerator
<p>Writes markdown to the output file.</p> <p> <em>Returns</em></p> Returns a Promise which resolves with the generated String when done. </td>

License

See LICENSE.

_{Markdown generated by [atomdoc-md](https://github.com/venkatperi/atomdoc-md).}