Add notes about npm

This commit is contained in:
Rico Sta. Cruz 2015-04-18 04:50:48 +08:00
parent ac5cccedb7
commit 251c5340cb
1 changed files with 19 additions and 2 deletions

21
ronn.md
View File

@ -35,8 +35,11 @@ or more line endings just like Markdown.
## OPTIONS ## OPTIONS
* `-R`, `--reporter`=[<name>] : * `-h`, `--help` :
Use the reporter <name>. Displays the help screen.
* `--version` :
Displays version information.
## EXAMPLES ## EXAMPLES
@ -121,6 +124,20 @@ See [Man page sections](http://www.december.com/unix/ref/mansec.html) (december.
| `7` | Misc | | `7` | Misc |
| `8` | System administration commands and procedures | | `8` | System administration commands and procedures |
## Using ronn with npm
Place manual files in `man/xxx.1.md`, then:
```js
"scripts": {
"prepublish": "npm run build-man",
"build-man": "ronn man/*.md --html --roff --style=toc,80c --organization=\"@rstacruz\""
},
"directories": {
"man": "man"
}
```
## JavaScript version ## JavaScript version
See [marked-man](https://github.com/kapouer/marked-man). See [marked-man](https://github.com/kapouer/marked-man).