toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
docs: "forges"
+6
-6
+2
-2
crates/mdbook-permalinks/src/main.rs
+2
-2
crates/mdbook-permalinks/src/main.rs
···
530
530
#[derive(clap::Parser, Deserialize, Debug, Default)]
531
531
#[serde(rename_all = "kebab-case", deny_unknown_fields)]
532
532
struct Config {
533
-
/// Use a custom link format for platforms other than GitHub.
533
+
/// Use a custom link format for forges other than GitHub.
534
534
///
535
535
/// Should be a string that contains the following placeholders that will be
536
536
/// filled in at build time:
···
547
547
/// ```
548
548
///
549
549
/// Note that information such as repo owner or name will not be filled in. If URLs to
550
-
/// your Git hosting service require such items, you should hard-code them in the pattern.
550
+
/// your Git forge require such items, you should hard-code them in the pattern.
551
551
#[serde(default)]
552
552
#[arg(long, value_name("FORMAT"), verbatim_doc_comment)]
553
553
repo_url_template: Option<String>,
+4
-4
docs/src/permalinks/features.md
+4
-4
docs/src/permalinks/features.md
···
17
17
18
18
> [!TIP]
19
19
>
20
-
> Not only is linking by paths well-supported by platforms such as
20
+
> Not only is linking by paths well-supported by forges such as
21
21
> [GitHub][github-relative-links], but editors like VS Code also provide smart features
22
22
> like [path completions][vscode-path-completions] and [link
23
23
> validation][link-validation].
24
24
25
25
**URL fragments** are preserved. For example, you may use fragments to link to specific
26
-
lines, if your Git hosting provider supports it:
26
+
lines, if your Git forge supports it:
27
27
28
28
> ```md
29
29
> This book uses [esbuild] to
···
56
56
> For Git remotes, both HTTP URLs and "scp-like" URIs (`git@github.com:org/repo.git`)
57
57
> are supported.
58
58
59
-
Currently, the preprocessor automatically uses repo URLs from the following providers:
59
+
Currently, the preprocessor automatically uses repo URLs from the following forges:
60
60
61
61
- GitHub, `https://github.com/*`
62
62
···
65
65
66
66
## Markdown images
67
67
68
-
Providers such as GitHub support two types of permalinks:
68
+
Forges such as GitHub support two types of permalinks:
69
69
70
70
- a `tree` or `blob` URL that opens the file's webpage for viewing
71
71
- a `raw` URL that directly serves the file's content, suitable for embedding or