Markdown Features

This page is a kitchen-sink demo for Markdown that Docspress converts into Gutenberg-compatible content.

Inline formatting

Docspress supports strong text, emphasis, deleted text, inline code, links, and manual line breaks.
This sentence follows a Markdown line break.

Lists

Use unordered lists for scannable notes:

• Convert Markdown locally.
• Preserve the docs folder hierarchy.
• Protect unmanaged WordPress pages.
  • Nested bullet content is kept inside the list item.
  • Additional nested items work too.

Use ordered lists for sequences:

1. Write Markdown in docs/.
2. Push to GitHub.
3. Let Docspress sync WordPress Pages.

GitHub-flavored task lists are accepted by the parser:

• Markdown source exists in Git.
• WordPress sync runs from GitHub Actions.
• Publish only after reviewing the generated pages.

Quote

Markdown stays canonical. WordPress receives generated Gutenberg content.

Code

JavaScript code fences become Gutenberg code blocks:

export function statusForRun(input) {
  return input === "publish" ? "publish" : "draft";
}

YAML examples stay readable:

with:
  status: draft
  create-h1: false
  dry-run: false

Code tabs use the same authoring pattern supported by the Gutenberg Handbook importer:

<Notice status="success">Docs synced.</Notice>

wp.element.createElement(
  wp.components.Notice,
  { status: "success" },
  "Docs synced."
);

Table

Image

Separator

Raw HTML

Raw Gutenberg block annotations

When you need exact Gutenberg markup, write serialized block comments directly in Markdown.

This quote was written as a raw Gutenberg block.

Self-closing block comments are preserved too.

Final paragraph

If this page syncs successfully, it exercises most of the content shapes a docs site usually needs.

Improve this page on GitHub