Respect sidebar_label when ordering the sidebar
#225
Merged
Conversation
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
The `sidebar_label` frontmatter field specifies the name to give a docs page on the auto-generated sidebar. Our custom sidebar ordering logic does not take `sidebar_label` into account when ordering sidebar items automatically by title. This change uses the `sidebar_label` value as the page's title if this frontmatter field is available. This way, sidebar labels continue to be sorted alphabetically unless the user overrides them with `sidebar_position` or the title includes "Introduction" or "Get Started". This change also renames `frontmatter` to `frontMatter` in the `docPage` type to match the data structure passed by Docusaurus.
|
Amplify deployment status
|
avatus
approved these changes
May 21, 2025
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.
The
sidebar_labelfrontmatter field specifies the name to give a docs page on the auto-generated sidebar. Our custom sidebar ordering logic does not takesidebar_labelinto account when ordering sidebar items automatically by title. This change uses thesidebar_labelvalue as the page's title if this frontmatter field is available. This way, sidebar labels continue to be sorted alphabetically unless the user overrides them withsidebar_positionor the title includes "Introduction" or "Get Started".This change also renames
frontmattertofrontMatterin thedocPagetype to match the data structure passed by Docusaurus.