toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
docs: update images
+72
-34
+2
-6
README.md
+2
-6
README.md
···
1
-
[](https://tonywu6.github.io/mdbookkit/)
2
-
3
1
# mdbookkit
4
2
5
3
Quality-of-life plugins for your [mdBook] project.
···
13
11
14
12
</div>
15
13
16
-
## Quick access
17
-
18
-
### [mdbook-rustdoc-links](https://tonywu6.github.io/mdbookkit/rustdoc-links)
14
+
## [mdbook-rustdoc-links](https://tonywu6.github.io/mdbookkit/rustdoc-links)
19
15
20
16
Link to Rust API docs by name, [_rustdoc_-style][rustdoc].
21
17
···
32
28
cargo install mdbook-rustdoc-links
33
29
```
34
30
35
-
### [mdbook-permalinks](https://tonywu6.github.io/mdbookkit/permalinks)
31
+
## [mdbook-permalinks](https://tonywu6.github.io/mdbookkit/permalinks)
36
32
37
33
Link to files in your Git repository using paths.
38
34
+4
-4
TODO.md
+4
-4
TODO.md
+3
-3
crates/mdbook-permalinks/src/page.rs
+3
-3
crates/mdbook-permalinks/src/page.rs
···
106
106
}
107
107
108
108
info!(
109
-
"Processed {total}: {permalink}; {rewritten}; {unreachable}; {unchanged}",
109
+
"Processed {total}: {permalink} to repo; {rewritten} to book; {unreachable}; {unchanged}",
110
110
total = plural!(total, "link"),
111
-
permalink = plural!(permalink, "permalink"),
112
-
rewritten = plural!(rewritten, "book link"),
111
+
permalink = plural!(permalink, "link"),
112
+
rewritten = plural!(rewritten, "link"),
113
113
unreachable = plural!(unreachable, "inaccessible path"),
114
114
unchanged = plural!(unchanged + ignored + error, "unchanged", "unchanged"),
115
115
);
+3
-3
crates/mdbook-permalinks/src/tests/paths.md
+3
-3
crates/mdbook-permalinks/src/tests/paths.md
···
20
20
21
21
22
22
23
-
23
+
24
24
25
-
[![Banner image][banner-image]][banner-image]
25
+
[![Social image][social-image]][social-image]
26
26
27
-
[banner-image]: /docs/src/media/banner.webp
27
+
[social-image]: /docs/src/media/social.webp
28
28
29
29
[](/LICENSE-APACHE.md)
30
30
+6
-6
crates/mdbook-permalinks/src/tests/snaps/_stderr.permalink.snap
+6
-6
crates/mdbook-permalinks/src/tests/snaps/_stderr.permalink.snap
···
26
26
╰────
27
27
╭─[crates/mdbook-permalinks/src/tests/paths.md:23:1]
28
28
│
29
-
│ 
29
+
│ 
30
30
· ────────────────┬───────────────
31
-
· ╰── https://example.org/git/raw/v0.0/docs/src/media/banner.webp
31
+
· ╰── https://example.org/git/raw/v0.0/docs/src/media/social.webp
32
32
│
33
-
│ [![Banner image][banner-image]][banner-image]
33
+
│ [![Social image][social-image]][social-image]
34
34
· ──────────────────────┬──────────────────────┬
35
-
· │ ╰── https://example.org/git/raw/v0.0/docs/src/media/banner.webp
36
-
· ╰── https://example.org/git/tree/v0.0/docs/src/media/banner.webp
35
+
· │ ╰── https://example.org/git/raw/v0.0/docs/src/media/social.webp
36
+
· ╰── https://example.org/git/tree/v0.0/docs/src/media/social.webp
37
37
│
38
-
│ [banner-image]: /docs/src/media/banner.webp
38
+
│ [social-image]: /docs/src/media/social.webp
39
39
│
40
40
│ [](/LICENSE-APACHE.md)
41
41
· ──────────────────────────────────────────────────────┬──────────────────────────────────────────────────────
+3
-3
crates/mdbook-permalinks/src/tests/snaps/paths.md.snap
+3
-3
crates/mdbook-permalinks/src/tests/snaps/paths.md.snap
···
24
24
25
25
26
26
27
-
27
+
28
28
29
-
[](https://example.org/git/tree/v0.0/docs/src/media/banner.webp)
29
+
[](https://example.org/git/tree/v0.0/docs/src/media/social.webp)
30
30
31
-
[banner-image]: /docs/src/media/banner.webp
31
+
[social-image]: /docs/src/media/social.webp
32
32
33
33
[](https://example.org/git/tree/v0.0/LICENSE-APACHE.md)
34
34
+1
-1
crates/mdbook-rustdoc-links/src/client.rs
+1
-1
crates/mdbook-rustdoc-links/src/client.rs
+1
-1
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/known-issues.md.snap
+1
-1
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/known-issues.md.snap
+24
docs/src/permalinks/logging.md
+24
docs/src/permalinks/logging.md
···
7
7
8
8
{{#include ../snippets/logging/output-style.md}}
9
9
10
+
<figure>
11
+
12
+
13
+
14
+
<figcaption>
15
+
16
+
Diagnostics are displayed in a graphical manner by default.
17
+
18
+
</figcaption>
19
+
20
+
</figure>
21
+
22
+
<figure>
23
+
24
+
25
+
26
+
<figcaption>
27
+
28
+
The same diagnostics emitted as logs
29
+
30
+
</figcaption>
31
+
32
+
</figure>
33
+
10
34
## `MDBOOK_LOG`
11
35
12
36
{{#include ../snippets/logging/env-var.md}}
docs/src/permalinks/media/diagnostics-tracing.png
docs/src/permalinks/media/diagnostics-tracing.png
This is a binary file and will not be displayed.
docs/src/permalinks/media/error-reporting-canonical-urls.png
docs/src/permalinks/media/error-reporting-canonical-urls.png
This is a binary file and will not be displayed.
docs/src/permalinks/media/error-reporting.png
docs/src/permalinks/media/error-reporting.png
This is a binary file and will not be displayed.
-6
docs/src/permalinks/more-ways-to-link.md
-6
docs/src/permalinks/more-ways-to-link.md
···
117
117
processes it as usual).
118
118
- For other sites, the link remains functional and will link to your book's website.
119
119
120
-
<figure>
121
-
122
-
123
-
124
-
</figure>
125
-
126
120
<!-- prettier-ignore-start -->
127
121
128
122
[mdbook-include]: https://rust-lang.github.io/mdBook/format/mdbook.html#including-files
+1
-1
docs/src/rustdoc-links/known-issues.md
+1
-1
docs/src/rustdoc-links/known-issues.md
+24
docs/src/rustdoc-links/logging.md
+24
docs/src/rustdoc-links/logging.md
···
7
7
8
8
{{#include ../snippets/logging/output-style.md}}
9
9
10
+
<figure>
11
+
12
+
13
+
14
+
<figcaption>
15
+
16
+
Diagnostics are displayed in a graphical manner by default.
17
+
18
+
</figcaption>
19
+
20
+
</figure>
21
+
22
+
<figure>
23
+
24
+
25
+
26
+
<figcaption>
27
+
28
+
The same diagnostics emitted as logs
29
+
30
+
</figcaption>
31
+
32
+
</figure>
33
+
10
34
## `MDBOOK_LOG`
11
35
12
36
{{#include ../snippets/logging/env-var.md}}
docs/src/rustdoc-links/media/diagnostics-graphical.png
docs/src/rustdoc-links/media/diagnostics-graphical.png
This is a binary file and will not be displayed.
docs/src/rustdoc-links/media/diagnostics-tracing.png
docs/src/rustdoc-links/media/diagnostics-tracing.png
This is a binary file and will not be displayed.
docs/src/rustdoc-links/media/error-reporting-wrong-line.png
docs/src/rustdoc-links/media/error-reporting-wrong-line.png
This is a binary file and will not be displayed.
docs/src/rustdoc-links/media/error-reporting.png
docs/src/rustdoc-links/media/error-reporting.png
This is a binary file and will not be displayed.
docs/src/rustdoc-links/media/screencap.webp
docs/src/rustdoc-links/media/screencap.webp
This is a binary file and will not be displayed.
docs/src/rustdoc-links/media/standalone-usage.png
docs/src/rustdoc-links/media/standalone-usage.png
This is a binary file and will not be displayed.