Files
wx_wherigo/libs/wxWidgets-3.3.1/3rdparty/libwebp/doc/specs_generation.md
2026-02-14 09:47:24 +01:00

1.0 KiB

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.