mdbook-tailor

Crates.iomdbook-tailor
lib.rsmdbook-tailor
version0.6.4
sourcesrc
created_at2023-03-14 10:24:51.374405
updated_at2024-03-16 00:53:38.99531
descriptionmdbook preprocessor for image-tailor
homepagehttps://github.com/CoralPink
repositoryhttps://github.com/CoralPink/mdbook-tailor
max_upload_size
id809697
size106,118
CoralPink (CoralPink)

documentation

https://github.com/CoralPink/mdbook-tailor/blob/main/README.md

README

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.

warning

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.

An Image Processing Library

It supports PNG, JPEG, GIF, WebP etc. as generally used in web pages 😉

🔺AVIF is not currently supported.

Installation

  1. Use cargo to install.
cargo install mdbook-tailor
  1. Add the following to book.toml.
[preprocessor.tailor]

Usage

  1. Use markdown notation as usual.
![example](example.webp)
  1. 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)

![left](l.webp) ![right](r.webp)

🔺Images in markdown tables are not detected.

Ex)

|Header|
|:---:|
|![center](c.webp)|

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 ☺️

License

Licensed under either of

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.

Commit count: 68

cargo fmt