mdbook-permalinks

For best results, view this page at https://docs.tonywu.dev/mdbookkit/permalinks.

Permalinks in mdBook!

With this preprocessor, you can easily link to any file in your Git repository in your mdBook documentation, without having to hard-code URLs or worry about broken links.

You simply write ...

Here is a link to the project's [Cargo.toml](/Cargo.toml).

... and you will get:

Here is a link to the project's Cargo.toml.

Overview

Follow the quickstart tutorial to try out the preprocessor!

Feature highlights:

• Use file paths as links. The preprocessor converts them to links to your Git repository.

• Links are anchored to the Git commit at the time your book is built.

• Supports repositories on GitHub, Codeberg, and Tangled out of the box, but you can also define your own permalink format.

• Use permalinks to display images and media files.

• Get warnings when links become broken.

License

This project is released under the Apache 2.0 License and the MIT License.