I'm in high school in Japan. I'm afraid that this article may include some unnatural points.

Motivation

I'm creating a web document that explains systematically what programming is all about. I used mdBook, a static site generator written in Rust. However, I found it doesn't support Sitemap generation.

mdBook has a rich ecosystem to expand its functionality. Luckily I found mdbook-sitemap-generator that supports my project.

USAGE:
    mdbook-sitemap-generator [OPTIONS] --domain <DOMAIN>

OPTIONS:
    -d, --domain <DOMAIN>
    -h, --help               Print help information
    -o, --output <OUTPUT>

$ ls
book  book.toml  src
$ mdbook-sitemap-generator -d docs.example.com -o book/sitemap.xml

However, it doesn't support the latest version of mdBook. There was an alternative sitemap-generation backend but written in Go. We can't install it through cargo. So I decided to make my own alternative.

LLM Assisted Coding

I asked Claude Sonnet to generate a simple sitemap generator written in 100% Rust. The code claude made includes implementation and unit tests. The unit tests passed. However, there is one mistake in the JSON format that mdBook sends to the custom backend.

Manual Coding

I added to it simple CI flows for validating project and integration test that simulate the latest version of mdBook behavior. Thanks to this setup, I was able to notice it doesn't run correctly.

I read mdBook documents and found JSON form mismatch. I revised the code and check if the integration test pass.

trait Tester: Sized {
    fn init_book_toml() -> &'static str;

    fn init_mock_contents(src_dir: &Path);

    fn validate_sitemap(book_dir: &Path);

    fn run_test() {
        // 1. initialize virtual file system
        // 2. make virtual book.toml
        // 3. make src/ SUMMARRY.md and each sections
        // 4. run mdBook build
        // 5. validate generated sitemap.xml
    }
}

I made Tester trait and make it easy to add various integration tests. If you want to see concrete implementation, see github.

https://github.com/sonneko/mdbook-sitemap/blob/main/tests/mod.rs

How to use it

No complex configuration is required! Just install through cargo and add very simple configurations on your book.toml.

cargo install mdbook-sitemap

[output.sitemap]
base-url = "https://example.com/docs"

Conclusion

Please feel free to use mdbook-sitemap. I'd appreciate it if you would give it a star.

Github:

cargo install mdbook-sitemap

[output.html]

[output.sitemap]
base-url = "https://example.com/docs/"
# Optional settings:
# change-freq = "weekly"          # always|hourly|daily|weekly|monthly|yearly|never
# priority = 0.7                  # 0.0 - 1.0
# output-filename = "sitemap.xml" # output filename
# include-draft = false           # whether to include draft chapters

Crates.io
https://crates.io/crates/mdbook-sitemap