webp/doc at 42c3b550ba7cd1490a0c8022a4e145a4db650dd5 - webp

History

Urvang Joshi a7305c2ef0 Clarification for unknown chunks clarify that writers may modify unknown chunks if they specifically intend to do so. Change-Id: I8348df2ec84648201ea781c7bfffd1f36eb3c8e5		2012-11-13 10:41:13 -08:00
..
README	Add kramdown version information to README	2012-06-20 14:17:36 -07:00
template.html	Lossless WebP doc largely ported to markdown text.	2012-06-15 14:52:57 -07:00
TODO	Update the WebP Container Spec.	2012-06-21 16:04:58 -07:00
webp-container-spec.txt	Clarification for unknown chunks	2012-11-13 10:41:13 -08:00
webp-lossless-bitstream-spec.txt	fixing the findings by Frederic Kayser to the bitstream spec	2012-07-18 22:47:11 -07:00

README

Generate libwebp Container Spec Docs from Text Source
=====================================================

HTML generation requires kramdown [1], easily installed as a
rubygem [2].  Rubygems installation should satisfy dependencies
automatically.

[1]: http://kramdown.rubyforge.org/
[2]: http://rubygems.org/

HTML generation can then be done from the project root:

$ kramdown doc/webp-container-spec.txt --template doc/template.html > \
  doc/output/webp-container-spec.html

kramdown can optionally syntax highlight code blocks, using CodeRay [3],
a dependency of kramdown that rubygems will install automatically.  The
following will apply inline CSS styling; an external stylesheet is not
needed.

$ kramdown doc/webp-lossless-bitstream-spec.txt --template \
  doc/template.html --coderay-css style --coderay-line-numbers ' ' \
  --coderay-default-lang c > \
  doc/output/webp-lossless-bitstream-spec.html

Optimally, use kramdown 0.13.7 or newer if syntax highlighting desired.

[3]: http://coderay.rubychan.de/