libwebp

mirror of https://github.com/webmproject/libwebp.git synced 2024-12-27 06:08:21 +01:00

History

James Zern b6f756e82b update http links - prefer https - metadataworkinggroup.org/com seem to be offline; the web archive link was obtained from exiftool: https://exiftool.org/TagNames/MWG.html - fix kramdown link, rubyforge has been gone a long time - fix png/zlib links Bug: webp:544 Bug: b/202302177 Change-Id: Id69de4553e7baf00393f12a2c1acb262443a1a93		2021-11-23 10:13:40 -08:00
..
README	update http links	2021-11-23 10:13:40 -08: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	update http links	2021-11-23 10:13:40 -08:00
webp-lossless-bitstream-spec.txt	update http links	2021-11-23 10:13:40 -08: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]: https://kramdown.gettalong.org/
[2]: https://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]: https://github.com/rubychan/coderay