This is a preprocessor for mdbook.
We plan to take some more time before a major release 🐣
🔺It includes some issues as noted in Issues.
The following warnings in PageSpeed Insights can be eliminated by using this preprocessor.
Explicitly setting the width and height of image elements will reduce layout deviations and improve CLS.
The image files that this project can handle depend on Imaging library.
It supports PNG, JPEG, GIF, WebP etc. as generally used in web pages 😉
🔺AVIF is not currently supported.
- Use
cargoto install.
cargo install mdbook-tailor- Add the following to
book.toml.
[preprocessor.tailor]- Use markdown notation as usual.
- Do the mdbook build as usual.
mdbook buildThe HTML generated from the above steps should contain the image size as measured by the mdbook-tailor.
In addition, a delayed loading setting will be added!
<img src="example.webp" alt="example" width="789" height="456" loading="lazy">This is actually a site I am producing myself
- GitHub Pages https://coralpink.github.io/commentary
- GitHub https://github.com/CoralPink/commentary
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.