toolkit for mdBook [mirror of my GitHub repo]
docs.tonywu.dev/mdbookkit/
permalinks
rust-analyzer
mdbook
chore: rewrite change logs
+175
-37
+2
-1
TODO.md
+2
-1
TODO.md
+59
-16
crates/mdbook-permalinks/CHANGELOG.md
+59
-16
crates/mdbook-permalinks/CHANGELOG.md
···
4
4
5
5
This file is autogenerated using [release-plz](https://release-plz.dev).
6
6
7
-
## [1.1.1](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.1.0...mdbookkit-v1.1.1)
7
+
## 2.0.0
8
+
9
+
[v1.1.2..v2.0.0](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.1.2...mdbook-permalinks-v2.0.0)
10
+
11
+
`mdbook-permalinks` is now a standalone package. To install the new version, use:
12
+
13
+
```sh
14
+
cargo install mdbook-permalinks
15
+
```
16
+
17
+
If you previously installed via the `mdbookkit` package, you should remove the old
18
+
binary:
8
19
9
-
### <!-- 1 --> Bug fixes
20
+
```sh
21
+
cargo uninstall mdbookkit
22
+
```
10
23
11
-
- generate slugs by actually emitting html
12
-
([#15](https://github.com/tonywu6/mdbookkit/pull/15))
13
-
[`19bb594`](https://github.com/tonywu6/mdbookkit/commit/19bb594362ba57bb9bf6714ba7ac7cbadd6e2326)
24
+
Note that the executable name has changed. You should also update the table name in
25
+
`book.toml`:
26
+
27
+
```diff
28
+
- [preprocessor.link-forever]
29
+
+ [preprocessor.permalinks]
30
+
```
31
+
32
+
### Added
33
+
34
+
- The preprocessor now processes URLs that point to the `HEAD` of your repo. You can
35
+
read more about
36
+
[why such URLs instead of paths may be desirable](/docs/src/permalinks/more-ways-to-link.md)
37
+
in the documentation.
38
+
39
+
- The preprocessor now warns about links pointing to files/directories that are
40
+
gitignored.
41
+
42
+
### Fixed
43
+
44
+
- Path-based links that are used in Markdown images are now
45
+
[correctly converted to `raw` URLs instead of `tree` URLs](/docs/src/permalinks/features.md#markdown-images).
14
46
15
-
## [1.1.0](https://tonywu6.github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.0.1...mdbookkit-v1.1.0)
47
+
### Changed
16
48
17
-
### <!-- 0 --> Features
49
+
- **mdBook 0.5 is now supported.** See the [official migration guide][mdbook-0.5] for
50
+
more details.
51
+
- mdBook 0.4 is now unsupported, although as of mdBook 0.5.2, the preprocessor can
52
+
still run under mdBook 0.4. There is no guarantee that it will remain compatible in
53
+
the future.
18
54
19
-
- linking by URLs to remote HEAD
20
-
([#12](https://tonywu6.github.com/tonywu6/mdbookkit/pull/12))
21
-
[`9934a2f`](https://tonywu6.github.com/tonywu6/mdbookkit/commit/9934a2fe2deedd6761104f16232f9a8018b4d26b)
55
+
- `MDBOOK_LOG` is now the environment variable to control logging. This variable also
56
+
controls logging in the main `mdbook` program. Previously, the variable was
57
+
~~`RUST_LOG`~~.
58
+
- Logging is now implemented through `tracing`. The `MDBOOK_LOG` variable therefore
59
+
supports [all syntax supported by `tracing`][tracing_subscriber::filter::EnvFilter].
60
+
See [Logging](/docs/src/permalinks/logging.md) for more information.
22
61
23
-
## [1.0.1](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.0.0...mdbookkit-v1.0.1)
62
+
- **\[BREAKING\]** The `book.toml` config table for this preprocessor is now
63
+
`[preprocessor.permalinks]`.
24
64
25
-
### <!-- 5 --> Miscellaneous
65
+
### Documented
26
66
27
-
- fix version number ([#10](https://github.com/tonywu6/mdbookkit/pull/10))
28
-
- fix issues with crates.io README ([#9](https://github.com/tonywu6/mdbookkit/pull/9))
67
+
- Added a ["More ways to link"](/docs/src/permalinks/more-ways-to-link.md) page that
68
+
clarifies the different types of linking supported by this preprocessor, as well as
69
+
when to use which.
29
70
30
-
## [1.0.0](https://tonywu6.github.com/tonywu6/mdbookkit/releases/tag/mdbookkit-v1.0.0)
71
+
- Added a dedicated ["Logging"](/docs/src/permalinks/logging.md) page.
31
72
32
-
Initial release.
73
+
<!-- prettier-ignore-start -->
74
+
[mdbook-0.5]: https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#05-migration-guide
75
+
<!-- prettier-ignore-end -->
+59
-14
crates/mdbook-rustdoc-links/CHANGELOG.md
+59
-14
crates/mdbook-rustdoc-links/CHANGELOG.md
···
4
4
5
5
This file is autogenerated using [release-plz](https://release-plz.dev).
6
6
7
-
## [1.1.2](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.1.1...mdbookkit-v1.1.2)
7
+
## 2.0.0
8
+
9
+
[v1.1.2..v2.0.0](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.1.2...mdbook-rustdoc-links-v2.0.0)
10
+
11
+
`mdbook-rustdoc-links` is now a standalone package. To install the new version, use:
12
+
13
+
```sh
14
+
cargo install mdbook-rustdoc-links
15
+
```
16
+
17
+
If you previously installed via the `mdbookkit` package, you should remove the old
18
+
binary:
19
+
20
+
```sh
21
+
cargo uninstall mdbookkit
22
+
```
23
+
24
+
Note that the executable name has changed. You should also update the table name in
25
+
`book.toml`:
26
+
27
+
```diff
28
+
- [preprocessor.rustdoc-link]
29
+
+ [preprocessor.rustdoc-links]
30
+
```
31
+
32
+
### Added
33
+
34
+
- Added a ["link report"](/docs/src/rustdoc-links/logging.md#link-report) logging
35
+
feature that prints a summary of all generated links upon build.
36
+
37
+
- The indexing process now presents more progress updates from rust-analyzer and should
38
+
feel more responsive.
39
+
40
+
- The preprocessor will emit a warning regarding caches if there are any broken links.
41
+
Broken links cause rust-analyzer to always run since they are always considered
42
+
unseen.
8
43
9
-
### <!-- 1 --> Bug fixes
44
+
- Diagnostic messages, such as for broken links, now
45
+
[include source locations (file:line:column) when the preprocessor is in logging mode](/docs/src/rustdoc-links/logging.md#output-style).
10
46
11
-
- Add a `rust-analyzer-timeout` option
12
-
([#17](https://github.com/tonywu6/mdbookkit/pull/17))
13
-
[`8a6e149`](https://github.com/tonywu6/mdbookkit/commit/8a6e1497298fa099ed3282fa603c10e7eb90000c)
47
+
### Changed
14
48
15
-
### <!-- 2 --> Refactor
49
+
- **mdBook 0.5 is now supported.** See the [official migration guide][mdbook-0.5] for
50
+
more details.
51
+
- mdBook 0.4 is now unsupported, although as of mdBook 0.5.2, the preprocessor can
52
+
still run under mdBook 0.4. There is no guarantee that it will remain compatible in
53
+
the future.
16
54
17
-
- print RA version on bail
18
-
[`0746536`](https://github.com/tonywu6/mdbookkit/commit/0746536cecb0a403d37121db43ca8ecc9c3871ee)
55
+
- `MDBOOK_LOG` is now the environment variable to control logging. This variable also
56
+
controls logging in the main `mdbook` program. Previously, the variable was
57
+
~~`RUST_LOG`~~.
58
+
- Logging is now implemented through `tracing`. The `MDBOOK_LOG` variable therefore
59
+
supports [all syntax supported by `tracing`][tracing_subscriber::filter::EnvFilter].
60
+
See [Logging](/docs/src/rustdoc-links/logging.md) for more information.
19
61
20
-
## [1.0.1](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.0.0...mdbookkit-v1.0.1)
62
+
- **\[BREAKING\]** The `book.toml` config table for this preprocessor is now
63
+
`[preprocessor.rustdoc-links]`.
21
64
22
-
### <!-- 5 --> Miscellaneous
65
+
- **\[BREAKING\]** The `smart-punctuation` option has been removed. It has no meaningful
66
+
effect on this preprocessor.
23
67
24
-
- fix version number ([#10](https://github.com/tonywu6/mdbookkit/pull/10))
25
-
- fix issues with crates.io README ([#9](https://github.com/tonywu6/mdbookkit/pull/9))
68
+
### Documented
26
69
27
-
## [1.0.0](https://tonywu6.github.com/tonywu6/mdbookkit/releases/tag/mdbookkit-v1.0.0)
70
+
- Added a dedicated ["Logging"](/docs/src/rustdoc-links/logging.md) page.
28
71
29
-
Initial release.
72
+
<!-- prettier-ignore-start -->
73
+
[mdbook-0.5]: https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#05-migration-guide
74
+
<!-- prettier-ignore-end -->
+51
-2
crates/mdbookkit/CHANGELOG.md
+51
-2
crates/mdbookkit/CHANGELOG.md
···
4
4
5
5
This file is autogenerated using [release-plz](https://release-plz.dev).
6
6
7
-
## [1.0.1](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.0.0...mdbookkit-v1.0.1)
7
+
## 2.0.0
8
+
9
+
[v1.1.2..v2.0.0](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.1.2...mdbookkit-v2.0.0)
10
+
11
+
### Changed
12
+
13
+
- **\[BREAKING\]** Preprocessor binaries previously provided by this package are now in
14
+
their standalone packages. You should uninstall this package.
15
+
16
+
## [1.1.2](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.1.1...mdbookkit-v1.1.2)
17
+
18
+
### rustdoc-link
19
+
20
+
#### <!-- 1 --> Bug fixes
21
+
22
+
- Add a `rust-analyzer-timeout` option
23
+
([#17](https://github.com/tonywu6/mdbookkit/pull/17))
24
+
[`8a6e149`](https://github.com/tonywu6/mdbookkit/commit/8a6e1497298fa099ed3282fa603c10e7eb90000c)
25
+
26
+
#### <!-- 2 --> Refactor
27
+
28
+
- print RA version on bail
29
+
[`0746536`](https://github.com/tonywu6/mdbookkit/commit/0746536cecb0a403d37121db43ca8ecc9c3871ee)
30
+
31
+
## [1.1.1](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.1.0...mdbookkit-v1.1.1)
32
+
33
+
### link-forever
34
+
35
+
#### <!-- 1 --> Bug fixes
36
+
37
+
- generate slugs by actually emitting html
38
+
([#15](https://github.com/tonywu6/mdbookkit/pull/15))
39
+
[`19bb594`](https://github.com/tonywu6/mdbookkit/commit/19bb594362ba57bb9bf6714ba7ac7cbadd6e2326)
40
+
41
+
## [1.1.0](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.0.1...mdbookkit-v1.1.0)
42
+
43
+
### link-forever
44
+
45
+
#### <!-- 0 --> Features
46
+
47
+
- linking by URLs to remote HEAD ([#12](https://github.com/tonywu6/mdbookkit/pull/12))
48
+
[`9934a2f`](https://github.com/tonywu6/mdbookkit/commit/9934a2fe2deedd6761104f16232f9a8018b4d26b)
49
+
50
+
# CHANGELOG
51
+
52
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
53
+
54
+
This file is autogenerated using [release-plz](https://release-plz.dev)
55
+
56
+
## [1.0.1](https://github.com/tonywu6/mdbookkit/compare/mdbookkit-v1.0.0...mdbookkit-v1.0.1) - 2025-04-08
8
57
9
58
### Other
10
59
11
60
- fix version number ([#10](https://github.com/tonywu6/mdbookkit/pull/10))
12
61
- fix issues with crates.io README ([#9](https://github.com/tonywu6/mdbookkit/pull/9))
13
62
14
-
## [1.0.0](https://tonywu6.github.com/tonywu6/mdbookkit/releases/tag/mdbookkit-v1.0.0)
63
+
## [1.0.0](https://github.com/tonywu6/mdbookkit/releases/tag/mdbookkit-v1.0.0) - 2025-04-08
15
64
16
65
Initial release.
+4
-4
crates/mdbookkit/README.md
+4
-4
crates/mdbookkit/README.md
···
23
23
> your `book.toml` as well:
24
24
>
25
25
> ```diff
26
-
> - [preprocessors.rustdoc-link]
27
-
> + [preprocessors.rustdoc-links]
28
-
> - [preprocessors.link-forever]
29
-
> + [preprocessors.permalinks]
26
+
> - [preprocessor.rustdoc-link]
27
+
> + [preprocessor.rustdoc-links]
28
+
> - [preprocessor.link-forever]
29
+
> + [preprocessor.permalinks]
30
30
> ```
31
31
32
32
<!-- prettier-ignore-start -->