Fatih Kadir Akın

This page documents the main inputs used by the demo workflow.

Input	Demo value	Purpose
wordpress-site	fkadev.blog	WordPress.com site domain.
docs-dir	docs	Source Markdown directory.
manifest-file	docs/docspress.manifest.json	Defines stable titles, slugs, parents, and Markdown sources.
redirects-file	docs/redirects.json	Creates managed moved-page placeholders for old docs paths.
root-slug	docs	Root WordPress page slug.
rewrite-links	true	Rewrites local Markdown links to generated WordPress page URLs.
edit-link	true	Appends an edit link to each Markdown-backed page.
status	draft	Keeps push-triggered syncs unpublished; manual runs can choose draft or publish.
create-h1	false	Manual runs can choose whether Docspress adds the page title as the first H1 block.
dry-run	false	The demo performs real WordPress writes.

Markdown coverage

See Markdown Features for examples of headings, lists, code blocks, tables, images, raw HTML, and raw Gutenberg block annotations.

See Gutenberg Importer Tricks for examples of manifest mode, redirect maps, local Markdown link rewriting, code tabs, and edit links.

Manual runs

Create or update draft pages without generated H1 blocks:

gh workflow run sync-docs.yml \
  --repo f/docspress-demo \
  -f status=draft \
  -f create_h1=false

Publish pages and include generated H1 blocks:

gh workflow run sync-docs.yml \
  --repo f/docspress-demo \
  -f status=publish \
  -f create_h1=true

Push-triggered runs always use status: draft and create-h1: false.

Secret

The workflow expects WP_ACCESS_TOKEN. Create and store it with the Docspress npm package:

npx docspress token \
  --client-id YOUR_CLIENT_ID \
  --client-secret YOUR_CLIENT_SECRET \
  --site fkadev.blog \
  --repo f/docspress-demo \
  --set-secret

Improve this page on GitHub