1
2Generate libwebp Container Spec Docs from Text Source
3=====================================================
4
5HTML generation requires kramdown [1], easily installed as a
6rubygem [2].  Rubygems installation should satisfy dependencies
7automatically.
8
9[1]: http://kramdown.rubyforge.org/
10[2]: http://rubygems.org/
11
12HTML generation can then be done from the project root:
13
14$ kramdown doc/webp-container-spec.txt --template doc/template.html > \
15  doc/output/webp-container-spec.html
16
17kramdown can optionally syntax highlight code blocks, using CodeRay [3],
18a dependency of kramdown that rubygems will install automatically.  The
19following will apply inline CSS styling; an external stylesheet is not
20needed.
21
22$ kramdown doc/webp-lossless-bitstream-spec.txt --template \
23  doc/template.html --coderay-css style --coderay-line-numbers ' ' \
24  --coderay-default-lang c > \
25  doc/output/webp-lossless-bitstream-spec.html
26
27Optimally, use kramdown 0.13.7 or newer if syntax highlighting desired.
28
29[3]: http://coderay.rubychan.de/
30