generate man pages from markdown

heapwolf / ldb

A C++ REPL / CLI for LevelDB

MIT License

201 stars 23 forks source link

generate man pages from markdown #36

Closed ralphtheninja closed 10 years ago

ralphtheninja commented 10 years ago

Fixes https://github.com/hij1nx/ldb/issues/26 and https://github.com/hij1nx/ldb/issues/31

A few things

Original man/ldb.1 is removed
Generate the man page by doing make docs
Generate docs, install docs and check them by doing make test-docs. Useful when editing the man/ldb.1.md file to check the final results
Reordered command line options
ronn is installed from devDependencies so a npm install is needed when writing man pages. I chose this so you aren't forced to install ronn globally

ralphtheninja commented 10 years ago

Please let me know if something should be added to man/ldb.1.md. I wasn't entirely sure what to add since a lot of things has changed since the first version of the man page, so I picked some from the first man page and some from README.md

ralphtheninja commented 10 years ago

I used a markdown file from @jwerle and just noticed I got some crap left at the end. SEE ALSO should reference leveldb but we can fix that next time the man page is updated.

heapwolf commented 10 years ago

Maybe for SEE ALSO

https://github.com/hij1nx/lev https://github.com/antirez/linenoise https://github.com/lukedeo/cmd-parser

as well, maybe SYNOPSIS should be USAGE and the current USAGE header should be EXAMPLES?

ralphtheninja commented 10 years ago

Sounds good. I'll make a new PR in a bit. Perhaps extend examples with some command line wizardry too :)