libwebp

mirror of https://github.com/webmproject/libwebp.git synced 2024-12-25 13:18:22 +01:00

History

Lou Quillio 7a18248716 Removed CodeRay syntax declarations ... ... as they became unnecessary when upstream (kramdown) implemented LQ feature request: `17625c8082` Also updated (and simplified) syntax-highlighting instructions. modified: doc/README modified: doc/webp-lossless-bitstream-spec.txt Change-Id: I6f02b0d0a69a4d1d96cb0f771936cbe9e2e6bbec		2012-06-15 14:53:39 -07:00
..
README	Removed CodeRay syntax declarations ...	2012-06-15 14:53:39 -07:00
template.html	Lossless WebP doc largely ported to markdown text.	2012-06-15 14:52:57 -07:00
TODO	More aggressive copy-edit; add TODO; validate HTML5	2011-10-12 15:54:02 -07:00
webp-container-spec.txt	doc: fix bit alignment in VP8X chunk	2012-05-24 12:33:48 -07:00
webp-lossless-bitstream-spec.txt	Removed CodeRay syntax declarations ...	2012-06-15 14:53:39 -07:00
webp-lossless-format-spec.pdf	doc: update lossless pdf	2012-06-04 16:53:16 -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

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