Skip to content

chore: fix READMEs #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tonywu6 merged 1 commit into from
Jul 20, 2026
Merged

chore: fix READMEs #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Quality-of-life plugins for your [mdBook] project!

[![link to documentation](https://img.shields.io/github/actions/workflow/status/tonywu6/mdbookkit/docs.yml?event=release&style=flat-square&label=docs)](https://docs.tonywu.dev/mdbookkit/index)
[![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/mdbookkit?style=flat-square)](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/LICENSE-APACHE.md)
[![MIT/Apache-2.0 licensed](https://img.shields.io/crates/l/mdbookkit?style=flat-square)](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/LICENSE-APACHE.md)

## mdbook-rustdoc-links

Expand Down Expand Up @@ -43,8 +43,8 @@ cargo install mdbook-permalinks

## License

This project is released under the [Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/LICENSE-APACHE.md) and the
[MIT License](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/LICENSE-MIT.md).
This project is released under the [Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/LICENSE-APACHE.md) and the
[MIT License](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/LICENSE-MIT.md).

<!-- prettier-ignore-start -->
[mdBook]: https://rust-lang.github.io/mdBook/
Expand Down
8 changes: 4 additions & 4 deletions crates/mdbook-permalinks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Here is a link to the project's [Cargo.toml](/Cargo.toml).

<figure class="fig-text">

Here is a link to the project's [Cargo.toml](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/Cargo.toml).
Here is a link to the project's [Cargo.toml](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/Cargo.toml).

</figure>

Expand All @@ -48,16 +48,16 @@ Feature highlights:
- [Get warnings](https://docs.tonywu.dev/mdbookkit/permalinks/getting-started#check) when links become broken.

<figure>
<img src="https://github.com/tonywu6/mdbookkit/raw/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/crates/mdbook-permalinks/tests/book_homepage/stderr/data.svg">
<img src="https://github.com/tonywu6/mdbookkit/raw/9fee25e50b174d4a456cad976f744198498d53ff/crates/mdbook-permalinks/tests/book_homepage/stderr/data.svg">
<figcaption>
Link rot happens all the time. The preprocessor will tell you about it.
</figcaption>
</figure>

## License

This project is released under the [Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/LICENSE-APACHE.md) and the
[MIT License](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/LICENSE-MIT.md).
This project is released under the [Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/LICENSE-APACHE.md) and the
[MIT License](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/LICENSE-MIT.md).

<!-- prettier-ignore-start -->
[mdBook]: https://rust-lang.github.io/mdBook/
Expand Down
6 changes: 3 additions & 3 deletions crates/mdbook-rustdoc-links/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Should you want to refactor your code, the preprocessor also checks your links,
can keep them up-to-date.

<figure>
<img src="https://github.com/tonywu6/mdbookkit/raw/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/crates/mdbook-rustdoc-links/tests/book_homepage/stderr/data.svg">
<img src="https://github.com/tonywu6/mdbookkit/raw/9fee25e50b174d4a456cad976f744198498d53ff/crates/mdbook-rustdoc-links/tests/book_homepage/stderr/data.svg">
</figure>

## Overview
Expand Down Expand Up @@ -85,8 +85,8 @@ Happy linking!

## License

This project is released under the [Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/LICENSE-APACHE.md) and the
[MIT License](https://github.com/tonywu6/mdbookkit/tree/7b0155dae0ba3eb0e31e8a8e5a0e5682915bd2d4/LICENSE-MIT.md).
This project is released under the [Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/LICENSE-APACHE.md) and the
[MIT License](https://github.com/tonywu6/mdbookkit/tree/9fee25e50b174d4a456cad976f744198498d53ff/LICENSE-MIT.md).

[^1]: Text adapted from [<cite>A Tour of The Rust Standard Library</cite>][tour]

Expand Down