Improve the sidebar generator #481
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
ptgott
force-pushed
the
paul.gottschling/2024-07-sidebar-a-z
branch
from
67e5c04 to
cf03cc5
Compare
ptgott
force-pushed
the
paul.gottschling/2024-07-sidebar-a-z
branch
from
cf03cc5 to
21a3604
Compare
ptgott
changed the title
ptgott
force-pushed
the
paul.gottschling/2024-07-sidebar-a-z
branch
from
8b08a80 to
a1096ae
Compare
ptgott
force-pushed
the
paul.gottschling/2024-07-sidebar-a-z
branch
from
a1096ae to
e221aa9
Compare
avatus
previously approved these changes
Jul 3, 2024
| @@ -72,6 +72,39 @@ const getEntryForPath = (fs, filePath) => { | |||
| }; | |||
| }; | |||
|
|
|||
| const sortByTitle = (a, b) => { | |||
There was a problem hiding this comment.
can you add a comment here describing the algorithm chosen for sorting? "if it includes this, sort alphabetically, otherwise go by title" or whatever
ptgott
force-pushed
the
paul.gottschling/2024-07-sidebar-a-z
branch
from
e221aa9 to
afda6d7
Compare
Improve the sidebar generator to accommodate the reorganized docs site. - Alphabetize auto-generated sidebar entries. The exception is any page that includes "Introduction" or "introduction" in the title. Elevate these to the first entry to avoid a confusing sidebar order. - Show third-level category pages in the sidebar without showing their contents. This way, we can add content one level beyond the level permitted in the sidebar while still showing the category page for that content in the sidebar. - Allow for a category page to be at the same level as its associated subdirectory. This is to accommodate the Terraform Provider reference which, because of the way it's generated, can only include a category page outside of its associated subdirectory. This does not abide by the Docusaurus convention, so we will need to figure out a solution eventually, but this is a quick alternative to tide us over. - Only add ".mdx" files to the sidebar. Otherwise, the generator attempts to add vim swapfiles etc.
ptgott
force-pushed
the
paul.gottschling/2024-07-sidebar-a-z
branch
from
afda6d7 to
52328f0
Compare
avatus
approved these changes
Jul 3, 2024
travelton
pushed a commit
that referenced
this pull request
Aug 26, 2024
Improve the sidebar generator to accommodate the reorganized docs site. - Alphabetize auto-generated sidebar entries. The exception is any page that includes "Introduction" or "introduction" in the title. Elevate these to the first entry to avoid a confusing sidebar order. - Show third-level category pages in the sidebar without showing their contents. This way, we can add content one level beyond the level permitted in the sidebar while still showing the category page for that content in the sidebar. - Allow for a category page to be at the same level as its associated subdirectory. This is to accommodate the Terraform Provider reference which, because of the way it's generated, can only include a category page outside of its associated subdirectory. This does not abide by the Docusaurus convention, so we will need to figure out a solution eventually, but this is a quick alternative to tide us over. - Only add ".mdx" files to the sidebar. Otherwise, the generator attempts to add vim swapfiles etc.
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.
Improve the sidebar generator to accommodate the reorganized docs site.
Alphabetize auto-generated sidebar entries.
The exception is any page that includes "Introduction" or
"introduction" in the title. Elevate these to the first entry to avoid
a confusing sidebar order.
Show third-level category pages in the sidebar without showing their
contents. This way, we can add content one level beyond the level
permitted in the sidebar while still showing the category page for
that content in the sidebar.
Allow for a category page to be at the same level as its associated
subdirectory. This is to accommodate the Terraform Provider reference
which, because of the way it's generated, can only include a category
page outside of its associated subdirectory. This does not abide by
the Docusaurus convention, so we will need to figure out a solution
eventually, but this is a quick alternative to tide us over.