toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
[link-forever] fix(ci): page order in snapshots
+65
-80
+4
-4
crates/mdbookkit/README.md
+4
-4
crates/mdbookkit/README.md
···
2
2
3
3
4
4
5
+
[](https://crates.io/crates/mdbookkit)
6
+
[](https://docs.rs/mdbookkit)
7
+
[](/LICENSE-APACHE.md)
8
+
5
9
Quality-of-life plugins for your [mdBook] project.
6
10
7
11
- [**`mdbook-rustdoc-link`**](https://tonywu6.github.io/mdbookkit/rustdoc-link)
···
12
16
- [**`mdbook-link-forever`**](https://tonywu6.github.io/mdbookkit/link-forever)
13
17
14
18
_Permalinks_ for your source tree: write relative paths, get links to GitHub.
15
-
16
-
[](https://crates.io/crates/mdbookkit)
17
-
[](https://docs.rs/mdbookkit)
18
-
[](/LICENSE-APACHE.md)
19
19
20
20
## Installation
21
21
+2
-2
crates/mdbookkit/src/bin/link_forever/diagnostic.rs
+2
-2
crates/mdbookkit/src/bin/link_forever/diagnostic.rs
···
1
1
use std::{
2
2
borrow::Cow,
3
-
collections::{BTreeMap, HashMap},
3
+
collections::BTreeMap,
4
4
fmt::{self, Display},
5
5
};
6
6
···
14
14
15
15
impl Environment {
16
16
pub fn report<'a>(&'a self, content: &'a Pages<'a>) -> Reporter<'a> {
17
-
let mut sorted: HashMap<&'_ Url, BTreeMap<LinkStatus, Vec<LinkDiagnostic<'_>>>> =
17
+
let mut sorted: BTreeMap<&'_ Url, BTreeMap<LinkStatus, Vec<LinkDiagnostic<'_>>>> =
18
18
Default::default();
19
19
20
20
let root = &self.vcs_root;
+4
-4
crates/mdbookkit/tests/snaps/link_forever/README.snap
+4
-4
crates/mdbookkit/tests/snaps/link_forever/README.snap
···
6
6
7
7
8
8
9
+
[](https://crates.io/crates/mdbookkit)
10
+
[](https://docs.rs/mdbookkit)
11
+
[](https://github.com/lorem/ipsum/tree/dolor/LICENSE-APACHE.md)
12
+
9
13
Quality-of-life plugins for your [mdBook] project.
10
14
11
15
- [**`mdbook-rustdoc-link`**](https://tonywu6.github.io/mdbookkit/rustdoc-link)
···
16
20
- [**`mdbook-link-forever`**](https://tonywu6.github.io/mdbookkit/link-forever)
17
21
18
22
_Permalinks_ for your source tree: write relative paths, get links to GitHub.
19
-
20
-
[](https://crates.io/crates/mdbookkit)
21
-
[](https://docs.rs/mdbookkit)
22
-
[](https://github.com/lorem/ipsum/tree/dolor/LICENSE-APACHE.md)
23
23
24
24
## Installation
25
25
+55
-70
crates/mdbookkit/tests/snaps/link_forever/_stderr.snap
+55
-70
crates/mdbookkit/tests/snaps/link_forever/_stderr.snap
···
3
3
expression: report
4
4
---
5
5
info: url ignored
6
+
╭─[crates/mdbookkit/README.md:5:1]
7
+
4 │
8
+
5 │ [](https://crates.io/crates/mdbookkit)
9
+
· ────────────────────────────────────────────────────────────────────────────────────────────────────────────────
10
+
6 │ [](https://docs.rs/mdbookkit)
11
+
· ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
12
+
7 │ [](/LICENSE-APACHE.md)
13
+
· ───────────────────────────────────────────────────────────────────────────────────────
14
+
8 │
15
+
9 │ Quality-of-life plugins for your [mdBook] project.
16
+
· ────────
17
+
10 │
18
+
11 │ - [**`mdbook-rustdoc-link`**](https://tonywu6.github.io/mdbookkit/rustdoc-link)
19
+
· ─────────────────────────────────────────────────────────────────────────────
20
+
12 │
21
+
13 │ _rustdoc_-style linking for Rust APIs: write types and function names, get links to
22
+
14 │ _docs.rs_
23
+
15 │
24
+
16 │ - [**`mdbook-link-forever`**](https://tonywu6.github.io/mdbookkit/link-forever)
25
+
· ─────────────────────────────────────────────────────────────────────────────
26
+
17 │
27
+
╰────
28
+
╭─[crates/mdbookkit/README.md:31:46]
29
+
30 │
30
+
31 │ Precompiled binaries are also available from [GitHub releases][gh-releases].
31
+
· ──────────────────────────────
32
+
32 │
33
+
╰────
34
+
35
+
info: path converted to permalink
36
+
╭─[crates/mdbookkit/README.md:3:1]
37
+
2 │
38
+
3 │ 
39
+
· ──────────────────────────┬─────────────────────────
40
+
· ╰── https://github.com/lorem/ipsum/tree/dolor/docs/src/media/banner.webp
41
+
4 │
42
+
5 │ [](https://crates.io/crates/mdbookkit)
43
+
6 │ [](https://docs.rs/mdbookkit)
44
+
7 │ [](/LICENSE-APACHE.md)
45
+
· ──────────────────────────────────────────────────────┬──────────────────────────────────────────────────────
46
+
· ╰── https://github.com/lorem/ipsum/tree/dolor/LICENSE-APACHE.md
47
+
8 │
48
+
╰────
49
+
╭─[crates/mdbookkit/README.md:35:36]
50
+
34 │
51
+
35 │ This project is released under the [Apache 2.0 License](/LICENSE-APACHE.md) and the
52
+
· ────────────────────┬───────────────────
53
+
· ╰── https://github.com/lorem/ipsum/tree/dolor/LICENSE-APACHE.md
54
+
36 │ [MIT License](/LICENSE-MIT.md).
55
+
· ───────────────┬──────────────
56
+
· ╰── https://github.com/lorem/ipsum/tree/dolor/LICENSE-MIT.md
57
+
37 │
58
+
╰────
59
+
60
+
info: url ignored
6
61
╭─[crates/mdbookkit/tests/tests/link-forever.md:45:13]
7
62
44 │
8
63
45 │ ## heading: <https://räksmörgås.josefsson.org/>
···
143
198
· ╰── #associated_items_on_primitive_types not found in crates/mdbookkit/tests/tests/ra-known-quirks.md
144
199
42 │
145
200
╰────
146
-
147
-
info: url ignored
148
-
╭─[crates/mdbookkit/README.md:5:34]
149
-
4 │
150
-
5 │ Quality-of-life plugins for your [mdBook] project.
151
-
· ────────
152
-
6 │
153
-
7 │ - [**`mdbook-rustdoc-link`**](https://tonywu6.github.io/mdbookkit/rustdoc-link)
154
-
· ─────────────────────────────────────────────────────────────────────────────
155
-
8 │
156
-
9 │ _rustdoc_-style linking for Rust APIs: write types and function names, get links to
157
-
10 │ _docs.rs_
158
-
11 │
159
-
12 │ - [**`mdbook-link-forever`**](https://tonywu6.github.io/mdbookkit/link-forever)
160
-
· ─────────────────────────────────────────────────────────────────────────────
161
-
13 │
162
-
14 │ _Permalinks_ for your source tree: write relative paths, get links to GitHub.
163
-
15 │
164
-
16 │ [](https://crates.io/crates/mdbookkit)
165
-
· ────────────────────────────────────────────────────────────────────────────────────────────────────────────────
166
-
17 │ [](https://docs.rs/mdbookkit)
167
-
· ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
168
-
18 │ [](/LICENSE-APACHE.md)
169
-
· ───────────────────────────────────────────────────────────────────────────────────────
170
-
19 │
171
-
╰────
172
-
╭─[crates/mdbookkit/README.md:31:46]
173
-
30 │
174
-
31 │ Precompiled binaries are also available from [GitHub releases][gh-releases].
175
-
· ──────────────────────────────
176
-
32 │
177
-
╰────
178
-
179
-
info: path converted to permalink
180
-
╭─[crates/mdbookkit/README.md:3:1]
181
-
2 │
182
-
3 │ 
183
-
· ──────────────────────────┬─────────────────────────
184
-
· ╰── https://github.com/lorem/ipsum/tree/dolor/docs/src/media/banner.webp
185
-
4 │
186
-
╰────
187
-
╭─[crates/mdbookkit/README.md:18:1]
188
-
17 │ [](https://docs.rs/mdbookkit)
189
-
18 │ [](/LICENSE-APACHE.md)
190
-
· ──────────────────────────────────────────────────────┬──────────────────────────────────────────────────────
191
-
· ╰── https://github.com/lorem/ipsum/tree/dolor/LICENSE-APACHE.md
192
-
19 │
193
-
20 │ ## Installation
194
-
21 │
195
-
22 │ If you are interested in any of these plugins, visit their respective pages for usage
196
-
23 │ instructions, linked above.
197
-
24 │
198
-
25 │ If you want to install all of them:
199
-
26 │
200
-
27 │ ```bash
201
-
28 │ cargo install mdbookkit --all-features
202
-
29 │ ```
203
-
30 │
204
-
31 │ Precompiled binaries are also available from [GitHub releases][gh-releases].
205
-
32 │
206
-
33 │ ## License
207
-
34 │
208
-
35 │ This project is released under the [Apache 2.0 License](/LICENSE-APACHE.md) and the
209
-
· ────────────────────┬───────────────────
210
-
· ╰── https://github.com/lorem/ipsum/tree/dolor/LICENSE-APACHE.md
211
-
36 │ [MIT License](/LICENSE-MIT.md).
212
-
· ───────────────┬──────────────
213
-
· ╰── https://github.com/lorem/ipsum/tree/dolor/LICENSE-MIT.md
214
-
37 │
215
-
╰────