18 releases (4 breaking)
0.4.2 | May 23, 2023 |
---|---|
0.4.1 | Apr 18, 2023 |
0.3.1 | Apr 11, 2023 |
0.2.2 | Apr 8, 2023 |
0.0.6 | Mar 21, 2023 |
#380 in Text processing
80 downloads per month
43KB
183 lines
mdbook-tailor
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.
Purpose
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.
Corresponding image file
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.
Installation
- Use
cargo
to install.
cargo install mdbook-tailor
- Add the following to
book.toml
.
[preprocessor.tailor]
Usage
- Use markdown notation as usual.

- Do the mdbook build as usual.
mdbook build
The 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">
Precautions
🔺Currently, tailor is not able to handle multiple image files on a single line.
Ex)
 
🔺Images in markdown tables are not detected.
Ex)
|Header|
|:---:|
||
Naturally I would like to be able to detect and process this as well, but I must admit I am out of my depth...❗😿
Example
This is actually a site I am producing myself ☺️
- GitHub Pages https://coralpink.github.io/commentary
- GitHub https://github.com/CoralPink/commentary
License
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.
Contribution
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.
Dependencies
~20–53MB
~820K SLoC