Repository navigation
fix(docs): close admonitions that swallowed the rest of the page - #629
Merged
Merged
Conversation
proseWrap: never joins an admonition without blank lines into a single ':::note ... :::' line, which Docusaurus never closes, so the rest of the page renders inside it. Prettier accepts that line, so check for it separately. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QhmaWLv4yExX8LahP5UtUb
Prettier's proseWrap: never joins a paragraph onto one line, so an admonition written without blank lines around its body ended up as ':::note ... :::' and Docusaurus never saw the closing fence. Blank lines keep the opening, body and closing fence in separate paragraphs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QhmaWLv4yExX8LahP5UtUb
chadoh
approved these changes
Oct 16, 2026
chadoh
left a comment
chadoh
left a comment
Contributor
There was a problem hiding this comment.
Love an inline bash script linter. The platonic ideal of simplicity.
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
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.
Three admonitions added in #612 never close on the deployed site, so everything after them renders inside the box:
configuration.md: theenvironments.tomlnote near the top and the "build supports onlyworkspace/contract" cautionextensions.md: theenvironments.tomlnoteCause. The docs' Prettier config sets
proseWrap: "never", which joins each paragraph onto one line. An admonition written without blank lines around its body is a single paragraph, so Prettier turns it into:::note … :::. Docusaurus only recognizes:::as a closing fence on its own line. The Docusaurus docs recommend putting blank lines around the body, which is the form every other admonition on the site already uses.Changes
lint:admonitionsand madenpm run linter(already run bywebsite.yml) call it. It fails on any admonition that opens and closes on the same line. Prettier accepts that line, so the check has to be separate. It uses POSIX character classes so it also works with macOS's grep.Testing
npm run linterfails and lists the three lines.docusaurus build --locale ensucceeds. In the built HTML, each of the three admonitions contains only its own text, and no stray:::remains on either page.🤖 Generated with Claude Code
https://claude.ai/code/session_01QhmaWLv4yExX8LahP5UtUb