tonywu.org / mdbookkit
toolkit for mdBook [mirror of my GitHub repo] docs.tonywu.dev/mdbookkit/
permalinks rust-analyzer mdbook
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: clean up link blocks

Tony Wu 39f45f9f 522cf679

+1 -52
-2
README.md
··· 52 52 and the [MIT License](https://github.com/tonywu6/mdbookkit/tree/HEAD/LICENSE-MIT.md). 53 53 54 54 <!-- prettier-ignore-start --> 55 - 56 55 [mdBook]: https://rust-lang.github.io/mdBook/ 57 56 [rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html 58 - 59 57 <!-- prettier-ignore-end -->
-2
crates/mdbook-permalinks/README.md
··· 30 30 ``` 31 31 32 32 <!-- prettier-ignore-start --> 33 - 34 33 [mdBook]: https://rust-lang.github.io/mdBook/ 35 34 [preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 36 35 [book]: https://tonywu6.github.io/mdbookkit/permalinks 37 - 38 36 <!-- prettier-ignore-end -->
-2
crates/mdbook-rustdoc-links/README.md
··· 44 44 [^1]: Text adapted from [<cite>A Tour of Tokio</cite>][tour] 45 45 46 46 <!-- prettier-ignore-start --> 47 - 48 47 [mdBook]: https://rust-lang.github.io/mdBook/ 49 48 [preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 50 49 [rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html 51 50 [book]: https://tonywu6.github.io/mdbookkit/rustdoc-links 52 51 [tour]: https://docs.rs/tokio/1.44.2/tokio/index.html#working-with-tasks 53 - 54 52 <!-- prettier-ignore-end -->
-4
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/getting-started.md.snap
··· 23 23 Alternatively, you may obtain precompiled binaries from [GitHub 24 24 releases][gh-releases]. 25 25 26 - <!-- TODO: cargo binstall --> 27 - 28 26 {{#include ../snippets/mdbook-0.4.md}} 29 27 30 28 ## Configure ··· 93 91 - Learn about [known issues and limitations](known-issues.md). 94 92 95 93 <!-- prettier-ignore-start --> 96 - 97 94 [gh-releases]: https://github.com/tonywu6/mdbookkit/releases 98 95 [open-docs]: https://rust-analyzer.github.io/book/features.html#open-docs 99 96 [preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 100 97 [ra-extension]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer 101 98 [ra-install]: https://rust-analyzer.github.io/book/rust_analyzer_binary.html 102 99 [rust-analyzer]: https://rust-analyzer.github.io/ 103 - 104 100 <!-- prettier-ignore-end -->
+1 -1
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/getting-started.md.stderr.snap
··· 3 3 expression: report 4 4 --- 5 5 info: link resolved 6 - ╭─[docs/src/rustdoc-links/getting-started.md:56:6] 6 + ╭─[docs/src/rustdoc-links/getting-started.md:54:6] 7 7 │ 8 8 │ Like [`std::thread::spawn`], [`tokio::task::spawn`] returns a 9 9 · ───────────┬────────── ───────────┬──────────
-2
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/index.md.snap
··· 90 90 [^1]: Text adapted from [<cite>A Tour of The Rust Standard Library</cite>][tour] 91 91 92 92 <!-- prettier-ignore-start --> 93 - 94 93 [mdBook]: https://rust-lang.github.io/mdBook/ 95 94 [preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 96 95 [rust-analyzer]: https://rust-analyzer.github.io/ 97 96 [rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html 98 97 [tour]: https://doc.rust-lang.org/stable/std/#a-tour-of-the-rust-standard-library 99 98 [workspaces]: https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html 100 - 101 99 <!-- prettier-ignore-end -->
-3
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/known-issues.md.snap
··· 1 1 --- 2 2 source: crates/mdbook-rustdoc-links/src/tests.rs 3 - assertion_line: 74 4 3 expression: output 5 4 --- 6 5 # Known issues ··· 133 132 </details> 134 133 135 134 <!-- prettier-ignore-start --> 136 - 137 135 [IpV6Addr]: https://doc.rust-lang.org/stable/core/net/enum.IpAddr.html#method.from-1 138 136 [macro_export]: https://doc.rust-lang.org/stable/reference/macros-by-example.html#path-based-scope 139 137 [panic]: https://doc.rust-lang.org/stable/std/macro.panic.html ··· 141 139 [serde_json::json]: https://docs.rs/serde_json/1.0.140/serde_json/macro.json.html 142 140 [sourcemap]: https://developer.mozilla.org/en-US/docs/Glossary/Source_map 143 141 [tokio::main]: https://docs.rs/tokio-macros/2.5.0/tokio_macros/attr.main.html 144 - 145 142 <!-- prettier-ignore-end -->
-2
crates/mdbook-rustdoc-links/src/tests/snaps/docs/src/rustdoc-links/supported-syntax.md.snap
··· 240 240 first. 241 241 242 242 <!-- prettier-ignore-start --> 243 - 244 243 [disambiguator]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html#namespaces-and-disambiguators 245 244 [gh-issues]: https://github.com/tonywu6/mdbookkit/issues 246 245 [namespaces]: https://doc.rust-lang.org/reference/names/namespaces.html 247 246 [rust-types]: https://doc.rust-lang.org/reference/types.html#r-type.kinds 248 247 [rustdoc-linking]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html 249 - 250 248 <!-- prettier-ignore-end -->
-2
crates/mdbookkit/README.md
··· 9 9 - [`mdbook-permalinks`](https://tonywu6.github.io/mdbookkit/permalinks/) 10 10 11 11 <!-- prettier-ignore-start --> 12 - 13 12 [mdBook]: https://rust-lang.github.io/mdBook/ 14 13 [preprocessors]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 15 - 16 14 <!-- prettier-ignore-end -->
-2
docs/src/permalinks/continuous-integration.md
··· 35 35 {{#include ../snippets/ci/error-handling.md}} 36 36 37 37 <!-- prettier-ignore-start --> 38 - 39 38 [`RUST_LOG`]: https://docs.rs/env_logger/latest/env_logger/#enabling-logging 40 39 [actions/checkout]: https://github.com/actions/checkout 41 40 [github-actions-ci]: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables 42 41 [gitlab-ci]: https://docs.gitlab.com/ci/variables/predefined_variables/ 43 42 [rustup-ra]: https://rust-analyzer.github.io/book/rust_analyzer_binary.html#rustup 44 - 45 43 <!-- prettier-ignore-end -->
-2
docs/src/permalinks/features.md
··· 105 105 </figure> 106 106 107 107 <!-- prettier-ignore-start --> 108 - 109 108 [`output.html.git-repository-url`]: https://rust-lang.github.io/mdBook/format/configuration/renderers.html#html-renderer-options 110 109 [esbuild]: https://esbuild.github.io 111 110 [github-relative-links]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#relative-links 112 111 [link-validation]: https://code.visualstudio.com/docs/languages/markdown#_link-validation 113 112 [mdbook-src-build]: https://rust-lang.github.io/mdBook/guide/creating.html#source-files 114 113 [vscode-path-completions]: https://code.visualstudio.com/docs/languages/markdown#_path-completions 115 - 116 114 <!-- prettier-ignore-end --> 117 115 118 116 [^1]: The remote must be exactly named `origin`. No other name is recognized.
-2
docs/src/permalinks/getting-started.md
··· 54 54 - Learn about [known issues and limitations](known-issues.md). 55 55 56 56 <!-- prettier-ignore-start --> 57 - 58 57 [gh-releases]: https://github.com/tonywu6/mdbookkit/releases 59 58 [git-repository-url]: https://rust-lang.github.io/mdBook/format/configuration/renderers.html#html-renderer-options 60 59 [preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 61 - 62 60 <!-- prettier-ignore-end -->
-2
docs/src/permalinks/index.md
··· 34 34 [MIT License](/LICENSE-MIT.md). 35 35 36 36 <!-- prettier-ignore-start --> 37 - 38 37 [mdBook]: https://rust-lang.github.io/mdBook/ 39 - 40 38 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/caching.md
··· 137 137 things, so hopefully bigger changes are coming! 138 138 139 139 <!-- prettier-ignore-start --> 140 - 141 140 [`ra-multiplex`]: https://github.com/pr2502/ra-multiplex 142 141 [gh-issues]: https://github.com/tonywu6/mdbookkit/issues 143 142 [lsp-work-done-progress]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workDoneProgress ··· 146 145 [ra-persistent-cache]: https://github.com/rust-lang/rust-analyzer/issues/4712 147 146 [salsa]: https://rust-analyzer.github.io/thisweek/2025/03/17/changelog-277.html 148 147 [specify-exclude-patterns]: https://rust-lang.github.io/mdBook/cli/serve.html#specify-exclude-patterns 149 - 150 148 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/continuous-integration.md
··· 39 39 [`rust-analyzer`](configuration.md#rust-analyzer) configuration option. 40 40 41 41 <!-- prettier-ignore-start --> 42 - 43 42 [dtolnay/rust-toolchain]: https://github.com/dtolnay/rust-toolchain 44 43 [rustup-ra]: https://rust-analyzer.github.io/book/rust_analyzer_binary.html#rustup 45 - 46 44 <!-- prettier-ignore-end -->
-4
docs/src/rustdoc-links/getting-started.md
··· 19 19 Alternatively, you may obtain precompiled binaries from [GitHub 20 20 releases][gh-releases]. 21 21 22 - <!-- TODO: cargo binstall --> 23 - 24 22 {{#include ../snippets/mdbook-0.4.md}} 25 23 26 24 ## Configure ··· 89 87 - Learn about [known issues and limitations](known-issues.md). 90 88 91 89 <!-- prettier-ignore-start --> 92 - 93 90 [gh-releases]: https://github.com/tonywu6/mdbookkit/releases 94 91 [open-docs]: https://rust-analyzer.github.io/book/features.html#open-docs 95 92 [preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 96 93 [ra-extension]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer 97 94 [ra-install]: https://rust-analyzer.github.io/book/rust_analyzer_binary.html 98 95 [rust-analyzer]: https://rust-analyzer.github.io/ 99 - 100 96 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/index.md
··· 86 86 [^1]: Text adapted from [<cite>A Tour of The Rust Standard Library</cite>][tour] 87 87 88 88 <!-- prettier-ignore-start --> 89 - 90 89 [mdBook]: https://rust-lang.github.io/mdBook/ 91 90 [preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 92 91 [rust-analyzer]: https://rust-analyzer.github.io/ 93 92 [rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html 94 93 [tour]: https://doc.rust-lang.org/stable/std/#a-tour-of-the-rust-standard-library 95 94 [workspaces]: https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html 96 - 97 95 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/known-issues.md
··· 128 128 </details> 129 129 130 130 <!-- prettier-ignore-start --> 131 - 132 131 [IpV6Addr]: https://doc.rust-lang.org/stable/core/net/enum.IpAddr.html#method.from-1 133 132 [macro_export]: https://doc.rust-lang.org/stable/reference/macros-by-example.html#path-based-scope 134 133 [panic]: https://doc.rust-lang.org/stable/std/macro.panic.html ··· 136 135 [serde_json::json]: https://docs.rs/serde_json/1.0.140/serde_json/macro.json.html 137 136 [sourcemap]: https://developer.mozilla.org/en-US/docs/Glossary/Source_map 138 137 [tokio::main]: https://docs.rs/tokio-macros/2.5.0/tokio_macros/attr.main.html 139 - 140 138 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/motivation.md
··· 30 30 > [original RFC][intra-doc-link]. 31 31 32 32 <!-- prettier-ignore-start --> 33 - 34 33 [intra-doc-link]: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html 35 34 [rustdoc]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html 36 35 [uv-brackets]: https://github.com/astral-sh/uv/pull/12076/files 37 - 38 36 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/name-resolution.md
··· 167 167 > useful information out of badly-shaped code][why-lsp]. 168 168 169 169 <!-- prettier-ignore-start --> 170 - 171 170 [didOpen]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_didOpen 172 171 [externalDocs]: https://rust-analyzer.github.io/book/contributing/lsp-extensions.html#open-external-documentation 173 172 [rustdoc-scoping]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html#valid-links 174 173 [why-lsp]: https://matklad.github.io/2022/04/25/why-lsp.html#Alternative-Theory:~:text=a%20language%20server%20must%20analyze%20any%20invalid%20program%20as%20best%20as%20it%20can.%20Working%20with%20incomplete%20and%20invalid%20programs%20is%20the%20first%20complication%20of%20a%20language%20server%20in%20comparison%20to%20a%20compiler. 175 - 176 174 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/supported-syntax.md
··· 236 236 first. 237 237 238 238 <!-- prettier-ignore-start --> 239 - 240 239 [disambiguator]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html#namespaces-and-disambiguators 241 240 [gh-issues]: https://github.com/tonywu6/mdbookkit/issues 242 241 [namespaces]: https://doc.rust-lang.org/reference/names/namespaces.html 243 242 [rust-types]: https://doc.rust-lang.org/reference/types.html#r-type.kinds 244 243 [rustdoc-linking]: https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html 245 - 246 244 <!-- prettier-ignore-end -->
-2
docs/src/rustdoc-links/workspace-layout.md
··· 134 134 ``` 135 135 136 136 <!-- prettier-ignore-start --> 137 - 138 137 [locate-project]: https://doc.rust-lang.org/cargo/commands/cargo-locate-project.html 139 138 [workspaces]: https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html 140 - 141 139 <!-- prettier-ignore-end -->
-2
docs/src/snippets/ci/detecting-ci.md
··· 12 12 is encapsulated in the [`is_ci`][crate::env::is_ci] function. 13 13 14 14 <!-- prettier-ignore-start --> 15 - 16 15 [github-actions-ci]: https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables 17 16 [gitlab-ci]: https://docs.gitlab.com/ci/variables/predefined_variables/#predefined-variables 18 - 19 17 <!-- prettier-ignore-end -->
-2
docs/src/snippets/logging/env-var.md
··· 19 19 > `MDBOOK_LOG`. This preprocessor supports both, with `MDBOOK_LOG` taking precedence. 20 20 21 21 <!-- prettier-ignore-start --> 22 - 23 22 [mdbook-init-logger]: https://github.com/rust-lang/mdBook/blob/v0.5.2/src/main.rs#L94-L97 24 23 [mdbook-init-logger-v0.4]: https://github.com/rust-lang/mdBook/blob/v0.4.52/src/main.rs#L111-L112 25 - 26 24 <!-- prettier-ignore-end -->