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

thlorenz/docme: Generates github compatible API documentation from your project ...

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

开源软件名称:

thlorenz/docme

开源软件地址:

https://github.com/thlorenz/docme

开源编程语言:

JavaScript 100.0%

开源软件介绍:

docme build status

Generates github compatible API documentation from your project's jsdocs and adds them to your Readme.

Installation

npm install docme

Usage

docme <readme> <docme-options> -- <jsdoc-options>

  Generates jsdocs for non-private members of the project in the current folder.
  It then updates the given README with the githubified version of the generated API docs.

  Note: overriding the jsdoc destination (-d, --destination) is not possible since docme will write files to a temp dir

OPTIONS:

  -l, --loglevel  level at which to log: silly|verbose|info|warn|error|silent -- default: info
  
  -h, --help      Print this help message.

EXAMPLES:
  
  Generate with default options and update README.md
    
    docme README.md

  Override [jsdocconf.json](http://usejsdoc.org/about-configuring-jsdoc.html):

    docme README.md -- --configure ./myconf.json

  Override loglevel and jsoc configuration:

    docme API.md --loglevel silly -- --configure ./myconf.json

Note: all functions that are not part of the public API should be marked as @private in order to exclude them from the docs generated by docme.

Helpful links

Since docme is using jsdoc under the hood, it is helpful to review its documentation. I highly recommend this page explaining how to specify @param types among other useful specs.

In order to make your docme APIs appear properly styled, please install the chrome extension or bookmarklet.

API

docme(readme, args, jsdocargs, cb)

Generates jsdocs for non-private members of the project in the current folder. It then updates the given README with the githubified version of the generated API docs.

Parameters:
Name Type Description
readme String

path to readme in which the API docs should be updated

args Array.<String>

consumed by docme

Properties
Name Type Argument Description
loglevel String <optional>

(info) level at which to log: silly|verbose|info|warn|error|silent

jsdocargs Array.<String>

consumed by jsdoc

cb function

called back when docme finished updating the README

Source:

generated with docme

License

MIT




鲜花

握手

雷人

路过

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

请发表评论

全部评论

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

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

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

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

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