feat(content-docs): allow explicitly disabling index page for generated category #6452
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
|
✔️ [V2] 🔨 Explore the source changes: 075fc44 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61f2969015619700084c7ba0 😎 Browse the preview: https://deploy-preview-6452--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-6452--docusaurus-2.netlify.app/ |
|
Size Change: +1.47 kB (0%) Total Size: 722 kB
ℹ️ View Unchanged
|
slorber
approved these changes
Jan 27, 2022
| @@ -218,8 +218,8 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({ | |||
|
|
|||
| function getCategoryLinkedDocId(): string | undefined { | |||
| const link = categoryMetadata?.link; | |||
| if (link) { | |||
| if (link.type === 'doc') { | |||
| if (link !== undefined) { | |||
There was a problem hiding this comment.
nice catch
can you add a test for this?
We already have one that you could use for inspiration:
test('uses explicit link over the index/readme.{md,mdx} naming convention', async () => {
mockCategoryMetadataFiles({
'Category/_category_.yml': {
label: 'Category label',
link: null
},
});
//...
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.
Motivation
While #6451 allows tweaking category index conventions globally, this one offers a more local customization: by explicitly setting
link: null, no conventions are applied for this single category.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
One dogfood test