• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

gberger/gulp-markdox: markdox plugin for gulp

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

gberger/gulp-markdox

开源软件地址(OpenSource Url):

https://github.com/gberger/gulp-markdox

开源编程语言(OpenSource Language):

CoffeeScript 73.5%

开源软件介绍(OpenSource Introduction):

gulp-markdox

NPM version Build Status Dependency Status devDependency Status License

Markdox is a structured documentation generator based on Dox, Markdown and EJS with support for JavaScript, CoffeeScript and Iced CoffeeScript. This plugin is a gulp wrapper for it.

Usage

First, install gulp-markdox as a development dependency:

npm install --save-dev gulp-markdox

Then, add it to your gulpfile.js:

var markdox = require("gulp-markdox");

gulp.task("doc", function(){
  gulp.src("./src/*.js")
    .pipe(markdox())
    .pipe(gulp.dest("./doc"));
});

It can take on .coffee and .iced files, too.

If you want to concatenate all your generated documentation files, use concat option. All parsed docfiles will be passed to template at once:

var markdox = require("gulp-markdox");

gulp.task("doc", function(){
  gulp.src("./src/*.js")
    .pipe(markdox({ concat: "doc.md" })
    .pipe(gulp.dest("./doc"));
});

Following example does the same in more fine-grained manner:

var markdox = require("gulp-markdox");

gulp.task("doc", function(){
  gulp.src("./src/*.js")
    .pipe(markdox.parse())
    .pipe(markdox.format())
    .pipe(markdox.render({ concat: "doc.md" }))
    .pipe(gulp.dest("./doc"));
});

API

Please refer to markdox's documentation for further documentation of these options.x'.

markdox(options)

Generates markdox documentation from source code in the input.

options.compiler

Type: Function

Custom compiler (user in parse phase).

options.encoding

Type: String Default: utf-8

Encoding of templates and files to parse (used in parse phase).

options.formatter

Type: Function

Custom formatter (used in format phase).

options.concat

Type: String

File name for concatenated docfile.

options.template

Type: String

Path or the custom template (used in render phase).

markdox.parse(options)

Input: commented source code in file contents.

Output: raw document object generated from comments assigned to javadoc property.

markdox.format(options)

Input: raw document object generated from comments assigned to javadoc property.

Output: formatted document object assigned to formattedDoc property.

markdox.render(options)

Input: formatted document object assigned to formattedDoc property.

Output: rendered documentation in file contents.

License

Copyright © 2016 Maciej Chałapuk. Released under MIT License.




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap