ENFR0.1.0-rc.3

Diagnostics

Every content and navigation code, and how to fix it.


Diagnostics point at a source location, e.g. source/docs/guides/attachments.md:42:7, or a config path, e.g. config#/navigation/1/items/0. Messages never quote your content. validate reports every problem in one run.

CodeLevelFix
ROUTE_SLUG_INVALIDerrorRename the file to lowercase-hyphen
ROUTE_COLLISIONerrorKeep one of page.md / page.mdx
CONTENT_FRONTMATTER_MISSINGerrorAdd a --- block with title
CONTENT_FRONTMATTER_UNKNOWN_FIELDerrorRemove the key
CONTENT_FRONTMATTER_INVALIDerrorCheck types; title not empty
CONTENT_HEADING_H1errorStart the body at ##
CONTENT_HEADING_SKIPPEDwarningDo not skip heading levels
CONTENT_HTML_FORBIDDENerrorUse Markdown or a component
CONTENT_EXPRESSION_FORBIDDENerrorUse string props
CONTENT_ESM_FORBIDDENerrorRemove import/export
CONTENT_UNSUPPORTEDerrorFootnotes, ref links, inline images
CONTENT_COMPONENT_UNKNOWNerrorCheck name and casing
CONTENT_COMPONENT_PROP_INVALIDerrorRemove unsupported props
CONTENT_COMPONENT_NESTING_INVALIDerrorCheck allowed children / Hero first
CONTENT_LINK_TARGET_MISSINGerrorFix the route or operation slug
CONTENT_LINK_ANCHOR_MISSINGwarningFix the #anchor
CONTENT_LINK_SCHEME_FORBIDDENerrorUse https:, mailto: or a route
CONTENT_ASSET_NOT_FOUNDerrorCheck the relative path
CONTENT_ASSET_UNSUPPORTEDerrorPNG, JPEG, WebP or GIF
CONTENT_ASSET_TOO_LARGEerror≤ 2 MiB each, 20 MiB total
CONTENT_BUDGET_EXCEEDEDerrorSplit the page
NAVIGATION_PAGE_MISSINGerrorFix the slug
NAVIGATION_PAGE_DUPLICATEerrorList each page once
NAVIGATION_PAGE_ORPHANEDwarningAdd it, or leave it hidden
NAVIGATION_DEPTH_EXCEEDEDerrorTwo section levels max
NAVIGATION_API_DUPLICATEerrorOne { api: true }
NAVIGATION_LINK_INVALIDerrorUse https:// or http://
Report an issue with this page on GitHub