feat(docs, blog): add support for tags.yml, predefined list of tags
#10137
+2,385
−510
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
⚡️ Lighthouse report for the deploy preview of this PR
|
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
slorber
requested changes
May 16, 2024
There was a problem hiding this comment.
We need :
export type VersionMetadata = ContentPaths & {
tagsFile: TagsFile | null;
tagsPath: string;
}We probably need to modify/rename this method
type TagsFile = Record<string, Tag>
export function normalizeFrontMatterTags(
/** Base path to append the tag permalinks to. */
tagsPath: string,
/** Can be `undefined`, so that we can directly pipe in `frontMatter.tags`. */
frontMatterTags: FrontMatterTag[] | undefined = [],
tagsFile: TagsFile
): Tag[]
packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
Outdated
Show resolved
Hide resolved
|
Size Change: +614 B (+0.04%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
slorber
added
pr: new feature
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
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
User request to have a predefined list of tags in a file which you can only choose from
Using a tags file, you can ensure that your tags usage is consistent across your plugin content set. Use the onInlineTags: 'throw' plugin option to enforce this consistency and prevent usage of inline tags declared on the fly.
Behavior :
undefined: search tags.yml by convention. Feature disabled if file does not existnull/false(default): feature disabled even if tags.yml existstagFile.yml: search for tagFile.yml and throw if file does not existWe check for duplicated tags permalink route and throw in case of duplication
Test Plan
yarn jest -tensureUniquePermalinksnormalizeTagsnormalize tagsnormalizeFrontMatterTagsprocessFileTagsPathDogfood
Test links
Guides:
API refs:
Tags pages blog:
Tags pages docs:
Related issues/PRs
fix #5913
#5975