node/tools/ronnjs/README

26 lines
595 B
Plaintext
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

ronnjs(1) -- markdown to roff converter
=======================================
## Synopsis
Javascript port of [ronn], using [markdown-js] to produce roff man pages.
Not fully compatible with [ronn], although it aims to be, wherever possible.
## Usage
This outputs doc.roff from a markdown file :
ronn.js --build --roff doc.md
Command-line options are listed with -h
## How it works ?
[markdown-js] parses markdown text to a document model, which in turn is
used to ouput a man page.
[ronn]: http://github.com/rtomayko/ronn
[markdown-js]: http://github.com/evilstreak/markdown-js