| 1 | Documentation
|
| 2 | =============
|
| 3 |
|
| 4 | ## HTML Docs
|
| 5 |
|
| 6 | I build these with a wrapper around CommonMark. Try:
|
| 7 |
|
| 8 | deps/from-tar.sh layer-cmark
|
| 9 |
|
| 10 | And then:
|
| 11 |
|
| 12 | build/doc.sh all-markdown
|
| 13 |
|
| 14 | The output HTML shows up in `_release/VERSION/doc`.
|
| 15 |
|
| 16 | See [doc-toolchain.md]() for details.
|
| 17 |
|
| 18 | ## Man pages
|
| 19 |
|
| 20 | `osh.1` is a [man page](https://en.wikipedia.org/wiki/Man_page) written using
|
| 21 | the [mdoc](http://mandoc.bsd.lv/man/mdoc.7.html) macro language for the troff
|
| 22 | (groff) formatter.
|
| 23 |
|
| 24 | You can view it with `man doc/osh.1`.
|
| 25 |
|