Public API
v1 package export surfaces for payload-markdown-docs.
Public API
@valkyrianlabs/payload-markdown-docs exposes a small v1 package surface.
Root
Use the root package for Payload plugin configuration:
1import { payloadMarkdownDocs } from '@valkyrianlabs/payload-markdown-docs'The root export also includes public plugin config types such as
PayloadMarkdownDocsConfig, PayloadMarkdownDocsAuthConfig,
PayloadMarkdownDocsSyncConfig, PayloadMarkdownDocsTargetConfig,
PayloadMarkdownDocsRoutingConfig, PayloadMarkdownDocsCollectionsConfig,
PayloadMarkdownDocsCollectionConfig, PayloadMarkdownDocsEndpointConfig,
PayloadMarkdownDocsPagesRoutingConfig,
PayloadMarkdownDocsSyncRevalidateConfig, DocsBlockInstallSelection,
DocsCollectionInstallConfig, and DocsMarketingBlockKey.
Do not import constants, routing helpers, sync helpers, security helpers, frontmatter parsers, manifest builders, or block schemas from the root package.
/next
Use /next in frontend/server route code:
1import {2 PayloadMarkdownDocsPage,3 PayloadMarkdownDocsNavbar,4 getDocsForSitemap,5 generatePayloadMarkdownDocsMetadata,6 getPayloadMarkdownDocsMetadata,7 resolvePayloadMarkdownDocsRoute,8} from '@valkyrianlabs/payload-markdown-docs/next'This surface owns route resolution, page rendering, metadata, sitemap helpers, navigation helpers, marketing render components, and the public asset route handler factory.
Use the nav/header builders for frontend navigation data.
/admin
Use /admin only for Payload import map components:
1import { DocsSetManager } from '@valkyrianlabs/payload-markdown-docs/admin'Admin data loaders and URL helpers are internal.
/blocks
Use /blocks for optional manual Payload block installation:
1import { DocsCTABlock } from '@valkyrianlabs/payload-markdown-docs/blocks'The v1 in-page block registry contains only DocsCTABlock.
Docs Excerpt is deferred until a first-class read-only markdown highlighter is available.
Sync planning, security, routing internals, hashing, frontmatter parsing, and manifest builders are internal package implementation details.
The CLI is the sync API for v1. The package does not expose a public /sync
SDK subpath.