Write ordinary Markdown for ordinary content and use DocsPress blocks where documentation needs richer semantics such as commands, results, API exchanges, or reusable prompts.
Authoring contract
- Put the documentation root at
docs/index.md. - Use folder
index.mdfiles for intentional section landing pages. - Add frontmatter
titleand begin body sections at##when the DocsPress theme renders the Page title. - Link pages with relative Markdown paths; DocsPress rewrites known documentation routes by default.
- Use real, verified examples with fake credentials and non-production identifiers.
- Keep serialized
wp:docspress/*comments as valid compact JSON.
Learn the formats
- Page structure and routes explains filenames, titles, parent Pages, links, manifests, and edit links.
- Markdown and Gutenberg maps Markdown features and explains when to choose each DocsPress block.
- DocsPress block reference lists exact attributes and allowed values.
- Kitchen Sink exercises every custom block and semantic state.