0.6.7 • Published 8 years ago
atomdoc-md v0.6.7
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 |
MarkdownGeneratorCLASS
License
See LICENSE.
0.6.7
8 years ago
0.6.6
8 years ago
0.6.5
8 years ago
0.6.4
8 years ago
0.6.3
8 years ago
0.6.2
8 years ago
0.6.1
8 years ago
0.6.0
8 years ago
0.5.7
8 years ago
0.5.6
8 years ago
0.5.5
8 years ago
0.5.4
8 years ago
0.5.3
8 years ago
0.5.2
8 years ago
0.5.1
8 years ago
0.5.0
8 years ago
0.4.0
8 years ago
0.3.0
8 years ago
0.2.0
8 years ago
0.1.0
8 years ago