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
main
libwebp/doc/specs_generation.md
James Zern 40e4ca60ea specs_generation.md: update kramdown command line 
coderay was extracted from the core and the options removed in 2.0.0.
See:
49e1b12f52

Change-Id: I5191dcec296ba4bcde5f0bcbc46d1e1135d40ec2
2024-09-06 15:32:26 -07:00

1.0 KiB
Raw Permalink Blame History

Generate libwebp Container Spec Docs from Text Source

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

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, 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 \
  -x syntax-coderay --syntax-highlighter coderay \
  --syntax-highlighter-opts "{default_lang: c, line_numbers: , css: style}" \
  > doc/output/webp-lossless-bitstream-spec.html

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