toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
refactor: add mdbookkit legacy bins
+69
-14
+8
-8
README.md
+8
-8
README.md
···
19
19
20
20
Link to Rust API docs by name, [_rustdoc_-style][rustdoc].
21
21
22
-
```sh
23
-
cargo install mdbook-rustdoc-links
24
-
```
25
-
26
22
<!-- prettier-ignore-start -->
27
23
28
24
[Install](https://tonywu6.github.io/mdbookkit/rustdoc-links/getting-started#install)
···
31
27
| [Options](https://tonywu6.github.io/mdbookkit/rustdoc-links/configuration)
32
28
33
29
<!-- prettier-ignore-end -->
30
+
31
+
```sh
32
+
cargo install mdbook-rustdoc-links
33
+
```
34
34
35
35
### [mdbook-permalinks](https://tonywu6.github.io/mdbookkit/permalinks)
36
36
37
37
Link to files in your Git repository using paths.
38
38
39
-
```sh
40
-
cargo install mdbook-permalinks
41
-
```
42
-
43
39
<!-- prettier-ignore-start -->
44
40
45
41
[Install](https://tonywu6.github.io/mdbookkit/permalinks/getting-started#install)
···
48
44
| [Options](https://tonywu6.github.io/mdbookkit/permalinks/configuration)
49
45
50
46
<!-- prettier-ignore-end -->
47
+
48
+
```sh
49
+
cargo install mdbook-permalinks
50
+
```
51
51
52
52
## License
53
53
+2
-1
TODO.md
+2
-1
TODO.md
+11
-5
crates/mdbookkit/Cargo.toml
+11
-5
crates/mdbookkit/Cargo.toml
···
42
42
[features]
43
43
_testing = ["dep:cargo-run-bin", "dep:insta", "dep:minijinja"]
44
44
45
-
[package.metadata.docs.rs]
46
-
all-features = true
47
-
48
-
[package.metadata.binstall]
49
-
pkg-url = "{ repo }/releases/download/{ name }-v{ version }/{ name }-{ target }{ archive-suffix }"
45
+
# defunct features
46
+
link-forever = []
47
+
rustdoc-link = []
48
+
[[bin]]
49
+
name = "mdbook-rustdoc-link"
50
+
path = "src/_bin/rustdoc_link.rs"
51
+
required-features = ["rustdoc-link"]
52
+
[[bin]]
53
+
name = "mdbook-link-forever"
54
+
path = "src/_bin/link_forever.rs"
55
+
required-features = ["link-forever"]
+24
crates/mdbookkit/src/_bin/link_forever.rs
+24
crates/mdbookkit/src/_bin/link_forever.rs
···
1
+
use std::process::exit;
2
+
3
+
use console::style;
4
+
5
+
fn main() {
6
+
eprintln!("Binaries from the `mdbookkit` package have been moved.");
7
+
eprintln!(
8
+
"You can reinstall it via the command {}",
9
+
style("cargo install mdbook-permalinks")
10
+
.for_stderr()
11
+
.bold()
12
+
.blue()
13
+
);
14
+
eprintln!(
15
+
"Note that the executable name has been changed to `{}` (from `{}`)",
16
+
style("mdbook-permalinks")
17
+
.for_stderr()
18
+
.bold()
19
+
.bright()
20
+
.white(),
21
+
style("mdbook-link-forever").for_stderr().strikethrough()
22
+
);
23
+
exit(2);
24
+
}
+24
crates/mdbookkit/src/_bin/rustdoc_link.rs
+24
crates/mdbookkit/src/_bin/rustdoc_link.rs
···
1
+
use std::process::exit;
2
+
3
+
use console::style;
4
+
5
+
fn main() {
6
+
eprintln!("Binaries from the `mdbookkit` package have been moved.");
7
+
eprintln!(
8
+
"You can reinstall it via the command {}",
9
+
style("cargo install mdbook-rustdoc-links")
10
+
.for_stderr()
11
+
.bold()
12
+
.blue()
13
+
);
14
+
eprintln!(
15
+
"Note that the executable name has been changed to `{}` (from `{}`)",
16
+
style("mdbook-rustdoc-links")
17
+
.for_stderr()
18
+
.bold()
19
+
.bright()
20
+
.white(),
21
+
style("mdbook-rustdoc-link").for_stderr().strikethrough()
22
+
);
23
+
exit(2);
24
+
}