vigour-doc

A collection of tools to help make great docs with minimal effort
vigour doc docs documentation badges jsdoc


Summary

Project Name vigour-doc Project Url https://github.com/vigour-io/doc#readme
InceptionYear 2016-03-20 10:21:58 更新时间 2016-08-21 18:36:46
IssueManagement https://github.com/vigour-io/doc/issues Licenses ISC
仓库地址 git+https://github.com/vigour-io/doc.git 用户数 0
Node Engine 文件大小 8.1 KB
install test cover view-cover travis

项目介绍

[![Build Status](https://travis-ci.org/vigour-io/doc.svg?branch=master)](https://travis-ci.org/vigour-io/doc) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![npm version](https://badge.fury.io/js/vigour-doc.svg)](https://badge.fury.io/js/vigour-doc) [![Coverage Status](https://coveralls.io/repos/github/vigour-io/doc/badge.svg?branch=master)](https://coveralls.io/github/vigour-io/doc?branch=master) # vigour-doc A collection of tools to help make great docs with minimal effort ```sh $ npm install vigour-doc ``` ## usage Opt-in to certain behaviors by including placeholder comments in your `.md` files. Then, run `vdoc` (see [vigour-config docs](https://github.com/vigour-io/config#readme)) ```sh $ vdoc ``` ### clean Cleans the generated content on files. **Important** it's necessary to pass true because of a small bug on [vigour-config](https://github.com/vigour-io/config/issues/18) ```sh $ vdoc --clean true ``` ## [badges]() ```gfm ``` - **name** : name of plugin - **options** : (optional) JSON options for plugin #### example *

README.md

* ```gfm ```

```gfm [![Build Status](https://travis-ci.org/vigour-io/doc.svg?branch=master)](https://travis-ci.org/vigour-io/doc) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![npm version](https://badge.fury.io/js/vigour-doc.svg)](https://badge.fury.io/js/vigour-doc) ``` See [vigour-doc-badges](https://github.com/vigour-io/doc-badges) for available badges ## [jsdoc]() Fetches the jsdoc-style comment block containing `@id `, converts it to github-flavoured markdown, and replaces the placeholder with the result ```md ``` - **ID** : Identifier to find the desired comment block #### example *

lib/start.js

* ```javascript /** * @id start * @function start * Searches the directory recursively and updates any vdoc sections */ module.exports = exports = function start () { ``` *

README.md

* ```gfm ```

```gfm **function** start Searches the directory recursively and updates any vdoc sections ```

Dependencys

GroupId ArtifactID Version 引用量
John-David Dalton lodash.merge 4.6.2 2437
John-David Dalton lodash.template 4.5.0 642
John-David Dalton lodash.trim 4.5.1 106
Vigour.io vigour-config 1.0.5 15
Vigour vigour-doc-badges 1.1.1 0
Vigour vigour-fs-promised 2.0.2 15
Vigour vigour-jsdoc2md 1.0.4 0

开发依赖

GroupId ArtifactID Version 引用量
Gregg Caines coveralls 3.0.9 38940
Krishnan Anantheswaran istanbul 0.4.5 223
John-David Dalton lodash.clonedeep 4.5.0 951
John-David Dalton lodash.filter 4.6.0 182
Scott Corgan tap-spec 5.0.0 4958
James Halliday tape 4.13.0 28863