ngdoc-md
Generate ngdoc with markdown format.
Last updated 3 years ago by okunishinishi .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install ngdoc-md 
SYNC missed versions from official npm registry.

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

Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 13
Dependencies (8)
Dev Dependencies (10)
Dependents (1)

Copyright 2014 - 2018 © taobao.org |