README.md
1# *Discount* Markdown compiler on Plan 9
2
3## Build
4 % CONFIG='--with-tabstops=7' mk config
5 % mk test
6 % mk install
7 % markdown -V
8 markdown: discount X.Y.Z TAB=7
9
10### Configuration
11To select features and extensions, `--with-tabstops=7` may be replaced by zero or more of:
12
13* `--enable-pandoc-header`: Use pandoc-style header blocks
14* `--enable-superscript`: `A^B` becomes A<sup>B</sup>
15* `--enable-amalloc`: Enable memory allocation debugging
16* `--with-tabstops=`*N*: Set tabstops to *N* characters (default 4)
17* `--enable-alpha-list`: Enable `(a)/(b)/(c)` list markers
18* `--enable-all-features`: Turn on all stable optional features
19
20## Notes
211. This is not a port from POSIX to native Plan 9 APIs. The supplied
22`mkfile` merely drives Discount's own `configure.sh` through Plan 9's
23*APE* environment (in *pcc*(1)) to build the Discount source, then
24copies the result to locations appropriate for system-wide use on
25Plan 9.
26
272. There are a few other *mk*(1) targets:
28 * `install.libs`: Discount includes a C library and header.
29Installation is optional. Plan 9 binaries are statically linked.
30 * `install.man`: Add manual pages for *markdown* in sections 1, 2, and 6.
31 * `install.progs`: Extra programs. *makepage* writes complete XHTML
32documents, rather than fragments. *mkd2html* is similar, but produces
33HTML.
34