Total Pageviews

Wednesday 8 March 2017

Readme文档生成器-redok

Readme and documentation generator

Join the chat at https://gitter.im/adamrenklint/redok npm version npm monthly downloads GitHub stars GitHub forks npm dependencies
redok is a tool for generating README and repo documentation using Handlebars and Markdown, and aims to speed up the most common tasks.

Installation

$ npm install -g redok

Usage

Generate output files for all templates in the folder .docs. For example, .docs/README.md would become your project's main readme file.
$ redok

Options

It is possible to pass options to the command line tool.

Load templates and partials from .alternate/

$ redok --dir .alternate

Watch and regenerate on change

$ redok --watch

Partials

If your readme is growing, it's smart to split the template up into smaller chunks. All .hbs files in .docs/partials are available as Handlebars partials:
{{>foo}}
 
from  https://github.com/adamrenklint/redok

No comments:

Post a Comment