toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
docs: reorganize README (WIP)
+143
-10
+6
-6
TODO.md
+6
-6
TODO.md
···
1
1
- [ ] mdbookkit install compat
2
-
- [ ] lib.rs docstring
2
+
- [x] lib.rs docstring
3
3
4
-
- [ ] package readme
5
-
- [ ] permalinks
6
-
- [ ] rustdoc-links
7
-
- [ ] mdbookkit
8
-
- [ ] link check
4
+
- [x] package readme
5
+
- [x] permalinks
6
+
- [x] rustdoc-links
7
+
- [x] mdbookkit
8
+
- [x] link check
9
9
10
10
- [ ] images
11
11
- [ ] permalinks
+37
crates/mdbook-permalinks/README.md
+37
crates/mdbook-permalinks/README.md
···
1
1
# mdbook-permalinks
2
+
3
+
An [mdBook] [preprocessor] that lets you link to files in your Git repository using
4
+
paths instead of hard-coded URLs.
5
+
6
+
You simply write ...
7
+
8
+
```md
9
+
Here is a link to the project's [Cargo.toml](../Cargo.toml).
10
+
```
11
+
12
+
... and the preprocessor will convert the link to a versioned permalink during build.
13
+
Supports GitHub or
14
+
[your Git remote of choice](https://tonywu6.github.io/mdbookkit/permalinks/configuration#repo-url-template).
15
+
16
+
## To see it in action, [read the book!][book]
17
+
18
+
<!-- prettier-ignore-start -->
19
+
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)
25
+
26
+
<!-- prettier-ignore-end -->
27
+
28
+
```sh
29
+
cargo install mdbook-permalinks
30
+
```
31
+
32
+
<!-- prettier-ignore-start -->
33
+
34
+
[mdBook]: https://rust-lang.github.io/mdBook/
35
+
[preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html
36
+
[book]: https://tonywu6.github.io/mdbookkit/permalinks
37
+
38
+
<!-- prettier-ignore-end -->
+53
crates/mdbook-rustdoc-links/README.md
+53
crates/mdbook-rustdoc-links/README.md
···
1
1
# mdbook-rustdoc-links
2
+
3
+
An [mdBook] [preprocessor] that lets you link to Rust API docs by name,
4
+
[_rustdoc_-style][rustdoc]
5
+
6
+
Instead of manually sourcing URLs from [docs.rs](https://docs.rs), you simply write ...
7
+
8
+
```md
9
+
The [`tokio::time`] module provides utilities for tracking time and scheduling work.
10
+
This includes functions for setting [timeouts][tokio::time::timeout] for tasks,
11
+
[sleeping][tokio::time::sleep] work to run in the future, or [repeating an operation at
12
+
an interval][tokio::time::interval].
13
+
```
14
+
15
+
.. and you get:
16
+
17
+
<!-- (generated by running `cargo run -- markdown < README.md`) -->
18
+
19
+
<!-- prettier-ignore-start -->
20
+
21
+
> The [`tokio::time`](https://docs.rs/tokio/1.44.2/tokio/time/index.html "tokio::time") module provides utilities for tracking time and scheduling work.
22
+
> This includes functions for setting [timeouts](https://docs.rs/tokio/1.44.2/tokio/time/timeout/fn.timeout.html "tokio::time::timeout") for tasks,
23
+
> [sleeping](https://docs.rs/tokio/1.44.2/tokio/time/sleep/fn.sleep.html "tokio::time::sleep") work to run in the future, or [repeating an operation at
24
+
an interval](https://docs.rs/tokio/1.44.2/tokio/time/interval/fn.interval.html "tokio::time::interval"). [^1]
25
+
26
+
<!-- prettier-ignore-end -->
27
+
28
+
## To see it in action, [read the book!][book]
29
+
30
+
<!-- prettier-ignore-start -->
31
+
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)
37
+
38
+
<!-- prettier-ignore-end -->
39
+
40
+
```sh
41
+
cargo install mdbook-rustdoc-links
42
+
```
43
+
44
+
[^1]: Text adapted from [<cite>A Tour of Tokio</cite>][tour]
45
+
46
+
<!-- prettier-ignore-start -->
47
+
48
+
[mdBook]: https://rust-lang.github.io/mdBook/
49
+
[preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html
50
+
[rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html
51
+
[book]: https://tonywu6.github.io/mdbookkit/rustdoc-links
52
+
[tour]: https://docs.rs/tokio/1.44.2/tokio/index.html#working-with-tasks
53
+
54
+
<!-- prettier-ignore-end -->
+1
-1
crates/mdbook-rustdoc-links/src/sync.rs
+1
-1
crates/mdbook-rustdoc-links/src/sync.rs
···
94
94
/// Listens to events over an [`mpsc::Receiver<Poll<T>>`] and [notifies][Notify]
95
95
/// subscribers of [`Poll::Ready`], but only if they are not "immediately"
96
96
/// followed by more [`Poll::Pending`], the timing of which is determined by a
97
-
/// configured [buffering time][EventSampling::buffer].
97
+
/// configured [buffering time][Debouncing::debounce].
98
98
///
99
99
/// [debouncing]: https://developer.mozilla.org/en-US/docs/Glossary/Debounce
100
100
#[derive(Debug, Clone)]
+15
crates/mdbookkit/README.md
+15
crates/mdbookkit/README.md
···
1
1
# mdbookkit
2
+
3
+
Support library for [mdBook] [preprocessors] in the
4
+
[`mdbookkit`](https://github.com/tonywu6/mdbokkkit) project.
5
+
6
+
You may be looking for:
7
+
8
+
- [`mdbook-rustdoc-links`](https://tonywu6.github.io/mdbookkit/rustdoc-links/)
9
+
- [`mdbook-permalinks`](https://tonywu6.github.io/mdbookkit/permalinks/)
10
+
11
+
<!-- prettier-ignore-start -->
12
+
13
+
[mdBook]: https://rust-lang.github.io/mdBook/
14
+
[preprocessors]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html
15
+
16
+
<!-- prettier-ignore-end -->
+1
crates/mdbookkit/src/lib.rs
+1
crates/mdbookkit/src/lib.rs
+3
docs/src/SUMMARY.md
+3
docs/src/SUMMARY.md
+8
docs/src/_internal/mdbook-permalinks-README.md
+8
docs/src/_internal/mdbook-permalinks-README.md
+8
docs/src/_internal/mdbook-rustdoc-links-README.md
+8
docs/src/_internal/mdbook-rustdoc-links-README.md
+8
docs/src/_internal/mdbookkit-README.md
+8
docs/src/_internal/mdbookkit-README.md
+1
-1
docs/src/permalinks/index.md
+1
-1
docs/src/permalinks/index.md
···
3
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
-
documentation, without having to hardcode URLs or worry about broken links. You simply
6
+
documentation, without having to hard-code URLs or worry about broken links. You simply
7
7
write ...
8
8
9
9
```md
+2
-2
docs/src/permalinks/more-ways-to-link.md
+2
-2
docs/src/permalinks/more-ways-to-link.md
···
20
20
external : The link points to ...
21
21
relativePath : Use a relative path
22
22
absolutePath : Use an absolute path
23
-
bookUrl : Hardcode the URL to your <br>book's website
24
-
repoUrl : Hardcode the URL to your <br>Git remote
23
+
bookUrl : Hard-code the URL to your <br>book's website
24
+
repoUrl : Hard-code the URL to your <br>Git remote
25
25
26
26
start --> included: Yes
27
27
start --> relativePath: No