dany/libwebp
1
0
Fork 0
mirror of https://github.com/webmproject/libwebp.git synced 2024-11-19 20:08:28 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
df0e808fed
libwebp/doc
History
James Zern 1f5791398c cosmetics: remove use of 'sanity' / 'master' 
replace with more inclusive terms or remove the comment entirely if the
meaning was already clear.

Bug: webp:507
Change-Id: Ica3bbf751ebf79f6668df6e6209af770248ff4ca
2021-05-21 10:38:40 -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 Update the WebP Container Spec. 2012-06-21 16:04:58 -07:00
webp-container-spec.txt cosmetics: remove use of 'sanity' / 'master' 2021-05-21 10:38:40 -07:00
webp-lossless-bitstream-spec.txt doc: use two's complement explicitly for uint8->int8 conversion 2016-09-05 10:57:56 -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/