docs(sidebar): support docs/custom/ items and preserve hash anchors#2425
Merged
antfu merged 7 commits intoslidevjs:mainfrom Feb 10, 2026
Merged
docs(sidebar): support docs/custom/ items and preserve hash anchors#2425antfu merged 7 commits intoslidevjs:mainfrom
antfu merged 7 commits intoslidevjs:mainfrom
Conversation
✅ Deploy Preview for slidev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@slidev/client
create-slidev
create-slidev-theme
@slidev/parser
@slidev/cli
@slidev/types
commit: |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances the VitePress sidebar generation to support custom documentation files. The implementation adds parsing, matching, and display logic for markdown files in the docs/custom/ directory, allowing them to be referenced in feature page sidebars alongside existing guide and feature references.
Key changes:
- Added parsing for custom documentation files from
docs/custom/*.md - Extended the matching logic to recognize custom file types
- Improved link generation to properly support hash fragments in all reference types
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request updates the sidebar generation logic in
docs/.vitepress/sidebar-gen.tsto support a new category of sidebar items for custom documentation files. The changes ensure that markdown files indocs/custom/are parsed and can be referenced in the sidebar with a distinct label and icon.Sidebar generation enhancements:
docs/custom/directory and include them asParsedFileobjects for sidebar construction.'custom'.🛠️) and correct linking, alongside existing feature and guide types.Additional fix:
Fixed sidebar link generation to preserve URL fragments (hash anchors).
Previously, anything after # could be dropped, causing redirects to unintended locations.