Home

Awesome

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}}

Badges

redok comes with a few built-in partials for generating badges.

DescriptionCodeExample
Gitter chat{{>badges/gitter}};Join the chat at https://gitter.im/adamrenklint/redok
npm version{{>badges/npm-version}}npm version
npm downloads{{>badges/npm-downloads}}npm monthly downloads
npm dependencies{{>badges/npm-dependencies}}npm dependencies
npm devDependencies{{>badges/npm-devDependencies}}David devDependencies
Github stars{{>badges/github-stars}}GitHub stars
Github forks{{>badges/github-forks}}GitHub forks
Travis CI status{{>badges/travis}}Travis CI status
CodeClimate score{{>badges/codeclimate-score}}Code Climate score
CodeClimate coverage{{>badges/codeclimate-coverage}}Code Climate coverage

License

MIT © 2015 Adam Renklint

Generated with redok @ Friday June 12th, 2015 - 11:04:19 AM