vigour-doc

1.1.6 • Public • Published

Build Status js-standard-style npm version Coverage Status

vigour-doc

A collection of tools to help make great docs with minimal effort

$ 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)

$ vdoc

clean

Cleans the generated content on files. Important it's necessary to pass true because of a small bug on vigour-config

$ vdoc --clean true
## [badges]() ```gfm ```
  • name : name of plugin
  • options : (optional) JSON options for plugin

example

README.md

<!-- VDOC.badges travis; standard; npm -->

```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 for available badges

jsdoc

Fetches the jsdoc-style comment block containing @id <ID>, converts it to github-flavoured markdown, and replaces the placeholder with the result

<!-- VDOC.jsdoc <ID>  -->
  • ID : Identifier to find the desired comment block

example

lib/start.js

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

README.md

<!-- VDOC.jsdoc start -->

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

Package Sidebar

Install

npm i vigour-doc

Weekly Downloads

3

Version

1.1.6

License

ISC

Last publish

Collaborators

  • vigour-io