feat(theme-default): heading-sidebar #30
Merged
Conversation
This file contains 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
Mister-Hope
requested changes
Jan 27, 2024
| @@ -69,6 +69,7 @@ export default defineUserConfig({ | |||
| ], | |||
| }, | |||
| ], | |||
| '/heading-sidebar/': 'heading', | |||
There was a problem hiding this comment.
Could you change the strcture to:
sidebar/
auto/
auto.md
config/
1.md
2.md
README.md
I believe this could be better, thanks.
There was a problem hiding this comment.
To clarify, are you suggesting we remove the heading-sidebar folder and replace the sidebar folder with this structure?
There was a problem hiding this comment.
Yes! but a auto folder and a auto.md, auto folder is for theme config, and auto.md is for frontmatter.
This can be done in another pr, and e2e test cases completion welcome.
|
I created a docs PR for these changes. vuepress/docs#9 |
Mister-Hope
approved these changes
Jan 28, 2024
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.
Before submitting the PR, please make sure you do the following
close vuepress/core#123).What is the purpose of this pull request?
Description
The auto sidebar feature of the default theme is quite useful, especially in cases where the pages are autogenerated documentation from something like TypeDoc.
Currently you can only use the auto feature on all pages or manually specify the sidebar for every page. It would be great if you could turn the feature on per page as well.
This PR also contains the initial setup of the e2e tests for the default theme and a couple e2e tests of this new feature.
Screenshots
Before
After
closes #17