toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
docs: reorganize README (WIP)
+87
-52
+49
-1
README.md
+49
-1
README.md
···
4
4
5
5
Quality-of-life plugins for your [mdBook] project.
6
6
7
-
[](https://crates.io/crates/mdbookkit)
8
7
[](https://tonywu6.github.io/mdbookkit/)
9
8
[](/LICENSE-APACHE.md)
10
9
10
+
<div class="hidden">
11
+
12
+
## [For best results, read the book!](https://tonywu6.github.io/mdbookkit/)
13
+
14
+
</div>
15
+
16
+
## Quick access
17
+
18
+
### [mdbook-rustdoc-links](https://tonywu6.github.io/mdbookkit/rustdoc-links)
19
+
20
+
Link to Rust API docs by name, [_rustdoc_-style][rustdoc].
21
+
22
+
```sh
23
+
cargo install mdbook-rustdoc-links
24
+
```
25
+
26
+
<!-- prettier-ignore-start -->
27
+
28
+
[Install](https://tonywu6.github.io/mdbookkit/rustdoc-links/getting-started#install)
29
+
| [Quickstart](https://tonywu6.github.io/mdbookkit/rustdoc-links/getting-started#configure)
30
+
| [Features](https://tonywu6.github.io/mdbookkit/rustdoc-links/supported-syntax)
31
+
| [Options](https://tonywu6.github.io/mdbookkit/rustdoc-links/configuration)
32
+
33
+
<!-- prettier-ignore-end -->
34
+
35
+
### [mdbook-permalinks](https://tonywu6.github.io/mdbookkit/permalinks)
36
+
37
+
Link to files in your Git repository using paths.
38
+
39
+
```sh
40
+
cargo install mdbook-permalinks
41
+
```
42
+
43
+
<!-- prettier-ignore-start -->
44
+
45
+
[Install](https://tonywu6.github.io/mdbookkit/permalinks/getting-started#install)
46
+
| [Quickstart](https://tonywu6.github.io/mdbookkit/permalinks/getting-started#configure)
47
+
| [Features](https://tonywu6.github.io/mdbookkit/permalinks/features)
48
+
| [Options](https://tonywu6.github.io/mdbookkit/permalinks/configuration)
49
+
50
+
<!-- prettier-ignore-end -->
51
+
52
+
## License
53
+
54
+
This project is released under the
55
+
[Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/HEAD/LICENSE-APACHE.md)
56
+
and the [MIT License](https://github.com/tonywu6/mdbookkit/tree/HEAD/LICENSE-MIT.md).
57
+
11
58
<!-- prettier-ignore-start -->
12
59
13
60
[mdBook]: https://rust-lang.github.io/mdBook/
61
+
[rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html
14
62
15
63
<!-- prettier-ignore-end -->
+32
TODO.md
+32
TODO.md
···
1
+
- [ ] mdbookkit install compat
2
+
- [ ] lib.rs docstring
3
+
4
+
- [ ] package readme
5
+
- [ ] permalinks
6
+
- [ ] rustdoc-links
7
+
- [ ] mdbookkit
8
+
- [ ] link check
9
+
10
+
- [ ] images
11
+
- [ ] permalinks
12
+
- [ ] rustdoc-links
13
+
- [ ] mdbookkit
14
+
15
+
- [ ] package metadata
16
+
- [ ] permalinks
17
+
- [ ] rustdoc-links
18
+
- [ ] mdbookkit
19
+
20
+
- [ ] preprocess
21
+
- [ ] ra-version
22
+
- [ ] describe
23
+
24
+
- [ ] postprocess
25
+
- [ ] anchors
26
+
- [ ] external links
27
+
- [ ] socials
28
+
29
+
- [ ] changelog
30
+
- [ ] binstall
31
+
32
+
- [ ] CI
+1
crates/mdbook-permalinks/README.md
+1
crates/mdbook-permalinks/README.md
···
1
+
# mdbook-permalinks
+1
crates/mdbook-rustdoc-links/README.md
+1
crates/mdbook-rustdoc-links/README.md
···
1
+
# mdbook-rustdoc-links
-45
crates/mdbookkit/README.md
-45
crates/mdbookkit/README.md
···
1
1
# mdbookkit
2
-
3
-
4
-
5
-
[](https://crates.io/crates/mdbookkit)
6
-
[](https://tonywu6.github.io/mdbookkit/)
7
-
[](https://github.com/tonywu6/mdbookkit/tree/main/LICENSE-APACHE.md)
8
-
9
-
Quality-of-life plugins for your [mdBook] project.
10
-
11
-
- [**`mdbook-rustdoc-link`**](https://tonywu6.github.io/mdbookkit/rustdoc-link)
12
-
13
-
_rustdoc_-style linking for Rust APIs: write types and function names, get links to
14
-
_docs.rs_
15
-
16
-
- [**`mdbook-link-forever`**](https://tonywu6.github.io/mdbookkit/link-forever)
17
-
18
-
_Permalinks_ for your source tree: write relative paths, get links to GitHub.
19
-
20
-
## Installation
21
-
22
-
If you are interested in any of these plugins, visit their respective pages for usage
23
-
instructions, linked above.
24
-
25
-
If you want to install all of them:
26
-
27
-
```bash
28
-
cargo install mdbookkit --all-features
29
-
```
30
-
31
-
Precompiled binaries are also available from [GitHub releases][gh-releases].
32
-
33
-
## License
34
-
35
-
This project is released under the
36
-
[Apache 2.0 License](https://github.com/tonywu6/mdbookkit/tree/main/LICENSE-APACHE.md)
37
-
and the [MIT License](https://github.com/tonywu6/mdbookkit/tree/main/LICENSE-MIT.md).
38
-
39
-
<!-- prettier-ignore-start -->
40
-
41
-
[`mdbookkit`]: https://crates.io/crates/mdbookkit
42
-
[gh-releases]: https://github.com/tonywu6/mdbookkit/releases
43
-
[mdBook]: https://rust-lang.github.io/mdBook/
44
-
[preprocessors]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html
45
-
46
-
<!-- prettier-ignore-end -->
+1
-1
docs/book.toml
+1
-1
docs/book.toml
+1
-1
docs/src/permalinks/index.md
+1
-1
docs/src/permalinks/index.md
···
1
1
# mdbook-permalinks
2
2
3
-
Create permalinks to files in your Git repository just by using their paths.
3
+
Create permalinks to files in your Git repository using paths.
4
4
5
5
Link to source code, examples, configuration files, etc., in your [mdBook]
6
6
documentation, without having to hardcode URLs or worry about broken links. You simply
+2
-4
docs/src/permalinks/more-ways-to-link.md
+2
-4
docs/src/permalinks/more-ways-to-link.md
···
50
50
start with a `/` are resolved **relative to the root of your repository**:
51
51
52
52
> ```md
53
-
> The [home page](index.md) simply embeds the package
54
-
> [README](/crates/mdbook-permalinks/README.md).
53
+
> The [home page](/docs/src/index.md) simply embeds the project [README](/README.md).
55
54
> ```
56
55
>
57
-
> The [home page](index.md) simply embeds the package
58
-
> [README](/crates/mdbook-permalinks/README.md).
56
+
> The [home page](/docs/src/index.md) simply embeds the project [README](/README.md).
59
57
60
58
## Using URLs
61
59