Guide

Authoring documentation

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.md files for intentional section landing pages.
  • Add frontmatter title and 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 docspress:block config valid and update its semantic Markdown preview with it; legacy wp:docspress/* comments remain accepted input.

Learn the formats

Was this helpful?