mirror of
https://github.com/webmproject/libwebp.git
synced 2024-11-20 04:18:26 +01:00
54e61a3864
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
27 lines
983 B
Markdown
27 lines
983 B
Markdown
# Generate libwebp Container Spec Docs from Text Source
|
|
|
|
HTML generation requires [kramdown](https://kramdown.gettalong.org/), easily
|
|
installed as a [rubygem](https://rubygems.org/). Rubygems installation should
|
|
satisfy dependencies automatically.
|
|
|
|
HTML generation can then be done from the project root:
|
|
|
|
```shell
|
|
$ 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](https://github.com/rubychan/coderay), a dependency of kramdown that
|
|
rubygems will install automatically. The following will apply inline CSS
|
|
styling; an external stylesheet is not needed.
|
|
|
|
```shell
|
|
$ 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.
|