2011-10-04 19:11:15 +02:00
|
|
|
|
2012-06-01 21:02:41 +02:00
|
|
|
Generate libwebp Container Spec Docs from Text Source
|
|
|
|
|
=====================================================
|
2011-10-04 19:11:15 +02:00
|
|
|
|
2011-10-04 21:03:53 +02:00
|
|
|
HTML generation requires kramdown [1], easily installed as a
|
|
|
|
|
rubygem [2]. Rubygems installation should satisfy dependencies
|
|
|
|
|
automatically.
|
|
|
|
|
|
2021-11-17 20:16:58 +01:00
|
|
|
[1]: https://kramdown.gettalong.org/
|
|
|
|
|
[2]: https://rubygems.org/
|
2011-10-04 21:03:53 +02:00
|
|
|
|
2011-10-05 00:11:43 +02:00
|
|
|
HTML generation can then be done from the project root:
|
2011-10-04 21:03:53 +02:00
|
|
|
|
2011-10-05 00:11:43 +02:00
|
|
|
$ kramdown doc/webp-container-spec.txt --template doc/template.html > \
|
|
|
|
|
doc/output/webp-container-spec.html
|
2012-06-01 21:02:41 +02:00
|
|
|
|
|
|
|
|
kramdown can optionally syntax highlight code blocks, using CodeRay [3],
|
|
|
|
|
a dependency of kramdown that rubygems will install automatically. The
|
2012-06-04 22:52:19 +02:00
|
|
|
following will apply inline CSS styling; an external stylesheet is not
|
|
|
|
|
needed.
|
2012-06-01 21:02:41 +02:00
|
|
|
|
|
|
|
|
$ kramdown doc/webp-lossless-bitstream-spec.txt --template \
|
2012-06-04 22:52:19 +02:00
|
|
|
doc/template.html --coderay-css style --coderay-line-numbers ' ' \
|
|
|
|
|
--coderay-default-lang c > \
|
2012-06-01 21:02:41 +02:00
|
|
|
doc/output/webp-lossless-bitstream-spec.html
|
|
|
|
|
|
2012-05-26 02:11:02 +02:00
|
|
|
Optimally, use kramdown 0.13.7 or newer if syntax highlighting desired.
|
|
|
|
|
|
2021-11-17 20:16:58 +01:00
|
|
|
[3]: https://github.com/rubychan/coderay
|
