libwebp

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

History

Lou Quillio b7ac19fec9 Add kramdown version information to README Example kramdown command line to apply syntax highlighting requires kramdown latest. Command is slightly different for earlier versions. modified: doc/README Change-Id: Icda1197436b5c5ed936ceff53c1dc51aa4ce409b		2012-06-20 14:17:36 -07: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	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	Edit for consistency, usage and grammar.	2012-06-20 10:08:53 -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

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

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