Blame doc/README

Packit 9c6abc
Packit 9c6abc
Generate libwebp Container Spec Docs from Text Source
Packit 9c6abc
=====================================================
Packit 9c6abc
Packit 9c6abc
HTML generation requires kramdown [1], easily installed as a
Packit 9c6abc
rubygem [2].  Rubygems installation should satisfy dependencies
Packit 9c6abc
automatically.
Packit 9c6abc
Packit 9c6abc
[1]: http://kramdown.rubyforge.org/
Packit 9c6abc
[2]: http://rubygems.org/
Packit 9c6abc
Packit 9c6abc
HTML generation can then be done from the project root:
Packit 9c6abc
Packit 9c6abc
$ kramdown doc/webp-container-spec.txt --template doc/template.html > \
Packit 9c6abc
  doc/output/webp-container-spec.html
Packit 9c6abc
Packit 9c6abc
kramdown can optionally syntax highlight code blocks, using CodeRay [3],
Packit 9c6abc
a dependency of kramdown that rubygems will install automatically.  The
Packit 9c6abc
following will apply inline CSS styling; an external stylesheet is not
Packit 9c6abc
needed.
Packit 9c6abc
Packit 9c6abc
$ kramdown doc/webp-lossless-bitstream-spec.txt --template \
Packit 9c6abc
  doc/template.html --coderay-css style --coderay-line-numbers ' ' \
Packit 9c6abc
  --coderay-default-lang c > \
Packit 9c6abc
  doc/output/webp-lossless-bitstream-spec.html
Packit 9c6abc
Packit 9c6abc
Optimally, use kramdown 0.13.7 or newer if syntax highlighting desired.
Packit 9c6abc
Packit 9c6abc
[3]: http://coderay.rubychan.de/