docs: Fix VitePress build error in markdown documentation#378
Merged
Conversation
Fixed VitePress build error by wrapping `<pre>` tag in backticks to prevent Vue parser from treating it as an actual HTML element. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
Fixed a VitePress build error caused by an unescaped HTML tag in markdown documentation. The <pre> tag was being interpreted as a literal HTML element by the Vue parser, causing a "missing end tag" error during the build process.
Key Changes:
- Escaped the
<pre>tag reference in the documentation by wrapping it in backticks
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #378 +/- ##
=======================================
Coverage 70.08% 70.08%
=======================================
Files 45 45
Lines 4383 4383
Branches 4383 4383
=======================================
Hits 3072 3072
Misses 1011 1011
Partials 300 300 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Added KDL TextMate grammar from kdl-org/vscode-kdl - Configured VitePress/Shiki to load KDL language - Fixed HTML tag escaping in Rust doc comments This eliminates the "Language 'kdl' is not loaded" warnings during docs build and provides proper syntax highlighting for KDL code blocks. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Merged
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Nov 14, 2025
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [usage](https://github.com/jdx/usage) | minor | `2.6.0` -> `2.8.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>jdx/usage (usage)</summary> ### [`v2.8.0`](https://github.com/jdx/usage/blob/HEAD/CHANGELOG.md#280---2025-11-12) [Compare Source](jdx/usage@v2.7.0...v2.8.0) ##### 🚀 Features - add examples section to markdown and manpage generation by [@​jdx](https://github.com/jdx) in [#​380](jdx/usage#380) - add examples support to spec-level by [@​jdx](https://github.com/jdx) in [#​382](jdx/usage#382) ##### 🐛 Bug Fixes - allow blank comment lines in #USAGE blocks by [@​jdx](https://github.com/jdx) in [#​381](jdx/usage#381) ### [`v2.7.0`](https://github.com/jdx/usage/blob/HEAD/CHANGELOG.md#270---2025-11-11) [Compare Source](jdx/usage@v2.6.0...v2.7.0) ##### 🚀 Features - support bracketed header syntax by [@​okuuva](https://github.com/okuuva) in [#​377](jdx/usage#377) ##### 📚 Documentation - Fix VitePress build error in markdown documentation by [@​jdx](https://github.com/jdx) in [#​378](jdx/usage#378) ##### 🔍 Other Changes - integrate clap-sort to enforce alphabetical subcommand ordering by [@​jdx](https://github.com/jdx) in [#​370](jdx/usage#370) ##### 📦️ Dependency Updates - lock file maintenance by [@​renovate\[bot\]](https://github.com/renovate\[bot]) in [#​372](jdx/usage#372) - update rust crate clap-sort to v1.0.3 by [@​renovate\[bot\]](https://github.com/renovate\[bot]) in [#​373](jdx/usage#373) - update rust crate ctor to v0.6.1 by [@​renovate\[bot\]](https://github.com/renovate\[bot]) in [#​374](jdx/usage#374) - lock file maintenance by [@​renovate\[bot\]](https://github.com/renovate\[bot]) in [#​375](jdx/usage#375) ##### New Contributors - [@​okuuva](https://github.com/okuuva) made their first contribution in [#​377](jdx/usage#377) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS4xNzMuMSIsInVwZGF0ZWRJblZlciI6IjQxLjE3My4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
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.
Summary
Changes
<pre>tag in backticks in Rust doc comments (cli/src/cli/generate/markdown.rs:33)kdl-org/vscode-kdlshikiSetupTest plan
npm run docs:buildand confirmed build succeeds🤖 Generated with Claude Code
Note
Loads a custom KDL Shiki grammar in VitePress and updates CLI help text to use
<pre>in backticks, fixing markdown/Docs build parsing.markdown.shikiSetupand adddocs/.vitepress/grammars/kdl.tmLanguage.json.Replace <pre> tags...toReplaceWritten by Cursor Bugbot for commit c4e3a74. This will update automatically on new commits. Configure here.