Repository navigation
Fix docs build: pin enhanced-readabilities plugin, bump DocumenterVitepress - #541
Merged
Merged
Conversation
The 2.21 releases of @nolebase/vitepress-plugin-enhanced-readabilities require vitepress 2, which breaks npm install for every docs build. Pin it to the 2.18 line, as DocumenterVitepress 0.3.8 does, and bump to 0.3.8, which also lets citation hover previews be re-enabled. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes the Documentation build, which currently fails for every PR and on
mainduringnpm install:@nolebase/vitepress-plugin-enhanced-readabilitiesreleased 2.21.0 and 2.21.1 on 2026-10-13/14, and both require vitepress 2 (still in alpha). Our^2.18.2range picks them up, which conflicts withvitepress@^1.6.4.docs/package.json: pin the plugin to~2.18.2. The 2.18 line acceptsvitepress ^1.5.0. This is the same pin DocumenterVitepress made upstream in v0.3.8 (Fix CI: pin the enhanced-readabilities plugin, and don't fail the preview cleanup job LuxDL/DocumenterVitepress.jl#400). That pin only applies to its template, and we ship our ownpackage.json, so we don't get it automatically.docs/Project.toml: bump theDocumenterVitepresscompat to0.3.8, which includes the citation-preview fix (Fix citation previews in lists and across pages LuxDL/DocumenterVitepress.jl#399).docs/make.jl: re-enable citation hover previews, removing the TODO added in Fix documentation citations and disable hover previews pending upstream support #534.Moving to vitepress 2 is left for later: DocumenterVitepress's templates still target vitepress 1.6 (LuxDL/DocumenterVitepress.jl#303).
Checklist
docs/make.jl🤖 Generated with Claude Code