toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
docs: move to new domain
+55
-34
+12
-12
README.md
+12
-12
README.md
···
2
2
3
3
Quality-of-life plugins for your [mdBook] project.
4
4
5
-
[](https://tonywu6.github.io/mdbookkit/)
5
+
[](https://docs.tonywu.dev/mdbookkit/)
6
6
[](/LICENSE-APACHE.md)
7
7
8
8
<div class="hidden">
9
9
10
-
## [For best results, read the book!](https://tonywu6.github.io/mdbookkit/)
10
+
## [For best results, read the book!](https://docs.tonywu.dev/mdbookkit/)
11
11
12
12
</div>
13
13
14
-
## [mdbook-rustdoc-links](https://tonywu6.github.io/mdbookkit/rustdoc-links)
14
+
## [mdbook-rustdoc-links](https://docs.tonywu.dev/mdbookkit/rustdoc-links)
15
15
16
16
Link to Rust API docs by name, [_rustdoc_-style][rustdoc].
17
17
18
18
<!-- prettier-ignore-start -->
19
19
20
-
[Install](https://tonywu6.github.io/mdbookkit/rustdoc-links/getting-started#install)
21
-
| [Quickstart](https://tonywu6.github.io/mdbookkit/rustdoc-links/getting-started#configure)
22
-
| [Features](https://tonywu6.github.io/mdbookkit/rustdoc-links/supported-syntax)
23
-
| [Options](https://tonywu6.github.io/mdbookkit/rustdoc-links/configuration)
20
+
[Install](https://docs.tonywu.dev/mdbookkit/rustdoc-links/getting-started#install)
21
+
| [Quickstart](https://docs.tonywu.dev/mdbookkit/rustdoc-links/getting-started#configure)
22
+
| [Features](https://docs.tonywu.dev/mdbookkit/rustdoc-links/supported-syntax)
23
+
| [Options](https://docs.tonywu.dev/mdbookkit/rustdoc-links/configuration)
24
24
25
25
<!-- prettier-ignore-end -->
26
26
···
28
28
cargo install mdbook-rustdoc-links
29
29
```
30
30
31
-
## [mdbook-permalinks](https://tonywu6.github.io/mdbookkit/permalinks)
31
+
## [mdbook-permalinks](https://docs.tonywu.dev/mdbookkit/permalinks)
32
32
33
33
Link to files in your Git repository using paths.
34
34
35
35
<!-- prettier-ignore-start -->
36
36
37
-
[Install](https://tonywu6.github.io/mdbookkit/permalinks/getting-started#install)
38
-
| [Quickstart](https://tonywu6.github.io/mdbookkit/permalinks/getting-started#configure)
39
-
| [Features](https://tonywu6.github.io/mdbookkit/permalinks/features)
40
-
| [Options](https://tonywu6.github.io/mdbookkit/permalinks/configuration)
37
+
[Install](https://docs.tonywu.dev/mdbookkit/permalinks/getting-started#install)
38
+
| [Quickstart](https://docs.tonywu.dev/mdbookkit/permalinks/getting-started#configure)
39
+
| [Features](https://docs.tonywu.dev/mdbookkit/permalinks/features)
40
+
| [Options](https://docs.tonywu.dev/mdbookkit/permalinks/configuration)
41
41
42
42
<!-- prettier-ignore-end -->
43
43
+1
-1
crates/mdbook-permalinks/Cargo.toml
+1
-1
crates/mdbook-permalinks/Cargo.toml
···
12
12
13
13
categories = ["text-processing", "development-tools", "command-line-utilities"]
14
14
description = "Generate permalinks in mdBook using paths"
15
-
documentation = "https://tonywu6.github.io/mdbookkit/permalinks"
15
+
documentation = "https://docs.tonywu.dev/mdbookkit/permalinks"
16
16
keywords = ["mdbook", "markdown", "documentation", "git", "permalink"]
17
17
readme = "README.md"
18
18
+6
-6
crates/mdbook-permalinks/README.md
+6
-6
crates/mdbook-permalinks/README.md
···
11
11
12
12
... and the preprocessor will convert the link to a versioned permalink during build.
13
13
Supports GitHub or
14
-
[your Git remote of choice](https://tonywu6.github.io/mdbookkit/permalinks/configuration#repo-url-template).
14
+
[your Git forge of choice](https://docs.tonywu.dev/mdbookkit/permalinks/configuration#repo-url-template).
15
15
16
16
## To see it in action, [read the book!][book]
17
17
18
18
<!-- prettier-ignore-start -->
19
19
20
20
**Quick access**
21
-
| [Install](https://tonywu6.github.io/mdbookkit/permalinks/getting-started#install)
22
-
| [Quickstart](https://tonywu6.github.io/mdbookkit/permalinks/getting-started#configure)
23
-
| [Features](https://tonywu6.github.io/mdbookkit/permalinks/features)
24
-
| [Options](https://tonywu6.github.io/mdbookkit/permalinks/configuration)
21
+
| [Install](https://docs.tonywu.dev/mdbookkit/permalinks/getting-started#install)
22
+
| [Quickstart](https://docs.tonywu.dev/mdbookkit/permalinks/getting-started#configure)
23
+
| [Features](https://docs.tonywu.dev/mdbookkit/permalinks/features)
24
+
| [Options](https://docs.tonywu.dev/mdbookkit/permalinks/configuration)
25
25
26
26
<!-- prettier-ignore-end -->
27
27
···
32
32
<!-- prettier-ignore-start -->
33
33
[mdBook]: https://rust-lang.github.io/mdBook/
34
34
[preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html
35
-
[book]: https://tonywu6.github.io/mdbookkit/permalinks
35
+
[book]: https://docs.tonywu.dev/mdbookkit/permalinks
36
36
<!-- prettier-ignore-end -->
+1
-1
crates/mdbook-rustdoc-links/Cargo.toml
+1
-1
crates/mdbook-rustdoc-links/Cargo.toml
···
12
12
13
13
categories = ["text-processing", "development-tools", "command-line-utilities"]
14
14
description = "Link to Rust API docs by name in mdBook"
15
-
documentation = "https://tonywu6.github.io/mdbookkit/rustdoc-links"
15
+
documentation = "https://docs.tonywu.dev/mdbookkit/rustdoc-links"
16
16
keywords = ["mdbook", "markdown", "documentation", "rust-analyzer", "rustdoc"]
17
17
readme = "README.md"
18
18
+5
-5
crates/mdbook-rustdoc-links/README.md
+5
-5
crates/mdbook-rustdoc-links/README.md
···
30
30
<!-- prettier-ignore-start -->
31
31
32
32
**Quick access**
33
-
| [Install](https://tonywu6.github.io/mdbookkit/rustdoc-links/getting-started#install)
34
-
| [Quickstart](https://tonywu6.github.io/mdbookkit/rustdoc-links/getting-started#configure)
35
-
| [Features](https://tonywu6.github.io/mdbookkit/rustdoc-links/supported-syntax)
36
-
| [Options](https://tonywu6.github.io/mdbookkit/rustdoc-links/configuration)
33
+
| [Install](https://docs.tonywu.dev/mdbookkit/rustdoc-links/getting-started#install)
34
+
| [Quickstart](https://docs.tonywu.dev/mdbookkit/rustdoc-links/getting-started#configure)
35
+
| [Features](https://docs.tonywu.dev/mdbookkit/rustdoc-links/supported-syntax)
36
+
| [Options](https://docs.tonywu.dev/mdbookkit/rustdoc-links/configuration)
37
37
38
38
<!-- prettier-ignore-end -->
39
39
···
47
47
[mdBook]: https://rust-lang.github.io/mdBook/
48
48
[preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html
49
49
[rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html
50
-
[book]: https://tonywu6.github.io/mdbookkit/rustdoc-links
50
+
[book]: https://docs.tonywu.dev/mdbookkit/rustdoc-links
51
51
[tour]: https://docs.rs/tokio/1.44.2/tokio/index.html#working-with-tasks
52
52
<!-- prettier-ignore-end -->
+1
-1
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/index.md.snap
+1
-1
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/index.md.snap
+1
-1
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/supported-syntax.md.snap
+1
-1
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/supported-syntax.md.snap
+1
-1
crates/mdbookkit/Cargo.toml
+1
-1
crates/mdbookkit/Cargo.toml
···
11
11
repository.workspace = true
12
12
13
13
description = "Support library for mdBook preprocessors in the mdbookkit project"
14
-
documentation = "https://tonywu6.github.io/mdbookkit/"
14
+
documentation = "https://docs.tonywu.dev/mdbookkit/"
15
15
readme = "README.md"
16
16
17
17
[dependencies]
+23
-2
crates/mdbookkit/README.md
+23
-2
crates/mdbookkit/README.md
···
5
5
6
6
You may be looking for:
7
7
8
-
- [`mdbook-rustdoc-links`](https://tonywu6.github.io/mdbookkit/rustdoc-links/)
9
-
- [`mdbook-permalinks`](https://tonywu6.github.io/mdbookkit/permalinks/)
8
+
- [`mdbook-rustdoc-links`](https://docs.tonywu.dev/mdbookkit/rustdoc-links/)
9
+
- [`mdbook-permalinks`](https://docs.tonywu.dev/mdbookkit/permalinks/)
10
+
11
+
> [!NOTE]
12
+
>
13
+
> This package previously provided preprocessor binaries. The preprocessors are now
14
+
> published as standalone packages. You should no longer install this package:
15
+
>
16
+
> ```sh
17
+
> cargo uninstall mdbookkit
18
+
> # cargo install mdbook-rustdoc-links
19
+
> # cargo install mdbook-permalinks
20
+
> ```
21
+
>
22
+
> Note that the names of the executables have been updated, so you will need to update
23
+
> your `book.toml` as well:
24
+
>
25
+
> ```diff
26
+
> - [preprocessors.rustdoc-link]
27
+
> + [preprocessors.rustdoc-links]
28
+
> - [preprocessors.link-forever]
29
+
> + [preprocessors.permalinks]
30
+
> ```
10
31
11
32
<!-- prettier-ignore-start -->
12
33
[mdBook]: https://rust-lang.github.io/mdBook/
+1
-1
docs/README.md
+1
-1
docs/README.md
+1
-1
docs/book.toml
+1
-1
docs/book.toml
+1
-1
docs/src/rustdoc-links/index.md
+1
-1
docs/src/rustdoc-links/index.md