Document jsonld: false frontmatter opt-out for built-in JSON-LD - #7044
Open
fern-api[bot] wants to merge 1 commit into
Open
fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: bot_apk <apk@cognition.ai>
fern-api
Bot
requested review from
devalog,
jkonrath-postman and
nerminamiller-postman
as code owners
September 21, 2026 21:43
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -1,3 +1,7 @@ | |||
| <ParamField path="jsonld" type="boolean" required={false} default={true} toc={true}> | |||
| Set to `false` to suppress all built-in JSON-LD structured data for this page. Use this when you are injecting your own `TechArticle` or `BreadcrumbList` via a custom component and do not want Fern's generated output to appear alongside it. Any value other than `false` (including absent or `true`) leaves the built-in output unchanged. | |||
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'don't' instead of 'do not'.
Suggested change
| Set to `false` to suppress all built-in JSON-LD structured data for this page. Use this when you are injecting your own `TechArticle` or `BreadcrumbList` via a custom component and do not want Fern's generated output to appear alongside it. Any value other than `false` (including absent or `true`) leaves the built-in output unchanged. | |
| Set to `false` to suppress all built-in JSON-LD structured data for this page. Use this when you are injecting your own `TechArticle` or `BreadcrumbList` via a custom component and don't want Fern's generated output to appear alongside it. Any value other than `false` (including absent or `true`) leaves the built-in output unchanged. |
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-09-21-fern-ai-1fb7a4-b0743cb5.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
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.
Documented the new
jsonld: falsefrontmatter key. ThejsonldParamField was added to the sharedseo-fields-structured-data.mdxsnippet, which renders on both the SEO metadata page and the page-level settings page, so it appears beforejsonld:breadcrumbin both places. The SEO metadata page's "Structured data (JSON-LD)" section now explains thatjsonld: falsesuppresses all built-in JSON-LD, with a short frontmatter example, and the "Structured data properties" accordion intro on the page-level settings page now distinguishesjsonld: false(suppress everything) fromjsonld:breadcrumb(override only the breadcrumb trail).