feat(v2): include frontmatter in loadedContent doc metadatas #4495
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
|
[V1] Deploy preview success Built with commit 8b4cbdc |
|
Deploy preview for docusaurus-2 ready! Built with commit 8b4cbdc |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4495--docusaurus-2.netlify.app/ |
kaytwo
force-pushed
the
feat/frontmatter-in-globals
branch
from
647f8a3
to
3bc5541
Compare
|
going to close this for now as I don't think it's what we should do, cf #4492 |
|
oh actually this makes sense, it's just a "wording" issue. We want frontmatter in |
slorber
reviewed
Mar 24, 2021
| @@ -219,5 +219,6 @@ export function processDocMetadata({ | |||
| ) | |||
| : undefined, | |||
| sidebar_label: sidebarLabel, | |||
| frontMatter: options.includeFrontMatterInGlobals ? frontMatter : undefined, | |||
There was a problem hiding this comment.
I think we want frontMatter here in all cases
| @@ -12,6 +12,7 @@ export function toGlobalDataDoc(doc: DocMetadata): GlobalDoc { | |||
| id: doc.unversionedId, | |||
| path: doc.permalink, | |||
| sidebar: doc.sidebar, | |||
| ...(doc.frontMatter && {frontMatter: doc.frontMatter}), | |||
There was a problem hiding this comment.
I think we don't want frontmatter here, as it increases the size of all the site's pages
| @@ -38,6 +38,7 @@ export const DEFAULT_OPTIONS: Omit<PluginOptions, 'id'> = { | |||
| versions: {}, | |||
| editCurrentVersion: false, | |||
| editLocalizedFiles: false, | |||
| includeFrontMatterInGlobals: false, | |||
| @@ -54,6 +55,9 @@ export const OptionsSchema = Joi.object({ | |||
| editUrl: Joi.alternatives().try(URISchema, Joi.function()), | |||
| editCurrentVersion: Joi.boolean().default(DEFAULT_OPTIONS.editCurrentVersion), | |||
| editLocalizedFiles: Joi.boolean().default(DEFAULT_OPTIONS.editLocalizedFiles), | |||
| includeFrontMatterInGlobals: Joi.boolean().default( | |||
| @@ -174,6 +181,7 @@ export type GlobalDoc = { | |||
| id: string; | |||
| path: string; | |||
| sidebar: string | undefined; | |||
| frontMatter?: FrontMatter; | |||
| @@ -142,6 +148,7 @@ export type DocMetadataBase = LastUpdateData & { | |||
| // eslint-disable-next-line camelcase | |||
| sidebar_label?: string; | |||
| editUrl?: string | null; | |||
| frontMatter?: FrontMatter; | |||
slorber
reviewed
Mar 26, 2021
slorber
changed the title
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
Fixes #4492
Have you read the Contributing Guidelines on pull requests?
Yes.
Test Plan
Added a new test using the new config option. All previous tests still pass.
Related PRs
None right now, will add if this PR is accepted.