Readme and documentation generator
redok is a tool for generating README and repo documentation using Handlebars and Markdown, and aims to speed up the most common tasks.
$ npm install -g redok
Generate output files for all templates in the folder
.docs. For example,
.docs/README.md would become your project's main readme file.
It is possible to pass options to the command line tool.
Load templates and partials from
$ redok --dir .alternate
Watch and regenerate on change
$ redok --watch
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:
redok comes with a few built-in partials for generating badges.
Generated with redok @ Friday June 12th, 2015 - 11:04:19 AM