dany/libwebp
1
0
Fork 0
mirror of https://github.com/webmproject/libwebp.git synced 2024-12-26 21:58:22 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
0957fd69ee
libwebp/doc/specs_generation.md
Maryla 54e61a3864 Markdownify libwebp docs and reorganize them. 
Break the main README into into multiple pages in the doc/ directory,
except for the tests, swig and webp_js docs which are in the corresponding
directories.
The webp mux doc is merged into the API doc and the tools doc.

Change-Id: Ia407617dd88094f4662841d37947cfef80799914
2022-02-15 15:31:56 +00:00

983 B
Raw 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 --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.