mdbook: 0.4.52 -> 0.5.1#467009
Conversation
Apply patches to lix_2_93, lix_2_94, and git versions to support building documentation with mdbook 0.5. The patch is from upstream Lix commit 54df89f6, which maintains compatibility with both mdbook 0.4.x and 0.5.x. https://git.lix.systems/lix-project/lix/issues/1051
philiptaron
left a comment
There was a problem hiding this comment.
It's kind of messy, but I think this works. Doing a build.
|
We do need to target the |
Done.
The process for that is to take them from releases.nixos.org, where they haven't changed, so it would be a no-op. |
|
|
I don't care about nixVersions.git but the devenv failure looks concerning. |
Robert, mind checking out the build failures? I think we can land it after those are addressed.
Apply the mdbook 0.5 support patch to devenv's bundled Nix 2.30.4. The patch is from upstream Nix commit 5cbd7856, which maintains compatibility with both mdbook 0.4.x and 0.5.x. The doc/manual/package.nix file is excluded as it doesn't exist in cachix's Nix fork. NixOS/nix#14628
Update to latest Nix master which includes mdbook 0.5 support merged in PR NixOS#14690. NixOS/nix#14690
|
Hey @philiptaron, Thanks for the ping.
Known to be maintenance-heavy and not required
Regressions from mdbook upgrade. That seems to cover them all. I'll add the remaining regression to the TODO. |
philiptaron
left a comment
There was a problem hiding this comment.
Doing a build. Changes LGTM.
This comment was marked as outdated.
This comment was marked as outdated.
|
The upgrade tests are dumb, and I'm skipping them. |
Update helix documentation build for mdbook 0.5 compatibility.
Changes:
- Replace deprecated {{#previous}}/{{#next}} helpers with {{#if}} blocks
- Update link references from {{link}} to {{previous.link}}/{{next.link}}
- Escape HTML tags in command descriptions to prevent markdown parsing errors
- Fix book-html path in postInstall (../book-html instead of book-html)
The mdbook 0.5 release changed navigation helpers from block helpers to
simple objects, requiring template syntax updates in index.hbs.
Update engage documentation build for mdbook 0.5 compatibility. Changes: - Remove deprecated 'multilingual' field from book.toml - Update git-repository-icon from 'fa-git-square' to 'fab-square-git' The 'multilingual' field was removed in mdbook 0.5 as it was never used. The FontAwesome icon name changed from 'fa-git-square' (FA 4) to 'fab-square-git' (FA 5 brand icon) in the version bundled with mdbook 0.5.
This supports mdbook 0.5.
RaitoBezarius
left a comment
There was a problem hiding this comment.
On the Lix changes:
- tested stable and its docs
- tested cross on stable and its docs
|
8e38f10
TODO
engagehelixevil-helixmdbook-cmdrunmigrate to mdbook 0.5 FauconFan/mdbook-cmdrun#23Alternatively,
mdbook_0_4could be added.Things done
passthru.tests.nixpkgs-reviewon this PR. See nixpkgs-review usage../result/bin/.Context
Add a 👍 reaction to pull requests you find important.