toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
docs: add mdbook 0.4 note
+33
-4
+3
-1
TODO.md
+3
-1
TODO.md
+1
crates/mdbook-permalinks/src/main.rs
+1
crates/mdbook-permalinks/src/main.rs
···
552
552
#[arg(long, value_name("FORMAT"), verbatim_doc_comment)]
553
553
repo_url_template: Option<String>,
554
554
555
+
// TODO: cannot use `output.html.site-url` because it is always `/` during `mdbook serve`
555
556
/// Specify the canonical URL at which you deploy your book.
556
557
///
557
558
/// For example:
+2
-2
docs/book.toml
+2
-2
docs/book.toml
···
5
5
title = "mdbookkit"
6
6
7
7
[build]
8
-
build-dir = "dist"
8
+
build-dir = "dist/mdbookkit"
9
9
create-missing = false
10
10
extra-watch-dirs = ["app", "bin", "../crates", "Cargo.toml", "../README.md"]
11
11
···
17
17
git-repository-url = "https://github.com/tonywu6/mdbookkit"
18
18
hash-files = true
19
19
preferred-dark-theme = "ayu"
20
-
site-url = "/"
20
+
site-url = "https://tonywu6.github.io/mdbookkit/"
21
21
22
22
[output.html.playground]
23
23
runnable = false
+16
docs/src/permalinks/configuration.md
+16
docs/src/permalinks/configuration.md
···
11
11
```
12
12
13
13
<permalinks-options>(auto-generated)</permalinks-options>
14
+
15
+
## `output.html.git-repository-url`
16
+
17
+
> [!NOTE]
18
+
>
19
+
> This option is configured under [mdBook's `[output.html]`
20
+
> table][html-renderer-options].
21
+
22
+
If configured, this URL will be the prefix of the generated permalinks.
23
+
24
+
If not configured, the preprocessor will attempt to retrieve a URL from the Git remote
25
+
with the name `origin`.
26
+
27
+
<!-- prettier-ignore-start -->
28
+
[html-renderer-options]: https://rust-lang.github.io/mdBook/format/configuration/renderers.html#html-renderer-options
29
+
<!-- prettier-ignore-end -->
+2
docs/src/permalinks/getting-started.md
+2
docs/src/permalinks/getting-started.md
+2
-1
docs/src/rustdoc-links/getting-started.md
+2
-1
docs/src/rustdoc-links/getting-started.md
···
5
5
You will need to:
6
6
7
7
1. Have [rust-analyzer].:
8
-
9
8
- If you already use the [VS Code extension][ra-extension], no setup is required: the
10
9
preprocessor automatically uses the server binary packaged with it.
11
10
- Otherwise, [install][ra-install] rust-analyzer (e.g. via `rustup`) and make sure it
···
21
20
releases][gh-releases].
22
21
23
22
<!-- TODO: cargo binstall -->
23
+
24
+
{{#include ../snippets/mdbook-0.4.md}}
24
25
25
26
## Configure
26
27
+7
docs/src/snippets/mdbook-0.4.md
+7
docs/src/snippets/mdbook-0.4.md