ngdoc-md

1.0.3 • Public • Published

ngdoc-md

Build Status Code Climate Code Coverage npm Version

Generate ngdoc with markdown format.

Installation

npm install ngdoc-md --g

Usage

Generate ngdoc documents from js source files.

$ ngdoc-md "src/javascripts/**/*.js" "docs/apiguide"

Options

$ ngdoc-md -h
 
  Usage: ngdoc-md [options] <src> <dest>
 
  Options:
 
    -h, --help               output usage information
    -V, --version            output the version number
    -v, --verbose            Show verbose log.
    -b, --basedir <basedir>  Working directory path.
 
 

Programmatic API

ngdoc-md also provides programmatic API.

Install as a local module,

$ npm install ngdoc-md --save-dev

then,

#!/usr/bin/env node
 
var ngdocMd = require('ngdoc-md');
 
ngdocMd('src/javascripts/*.js', 'doc/apiguide', {}, function (err) {
    /*...*/
});

License

This software is released under the MIT License.

Links

Readme

Keywords

Package Sidebar

Install

npm i ngdoc-md

Weekly Downloads

11

Version

1.0.3

License

MIT

Last publish

Collaborators

  • okunishinishi