{"repo":"Automattic/docspress","free":true,"listed":false,"github":"https://github.com/Automattic/docspress","clone":"git clone https://github.com/Automattic/docspress.git","description":"Publish Markdown documentation from GitHub to native WordPress Pages and Gutenberg blocks.","language":"JavaScript","stars":25,"topics":["developer-tools","docs-as-code","documentation","github-actions","gutenberg","markdown","wordpress","wordpress-plugin","wordpress-theme"],"license":null,"category":"docs-static-sites","readme_excerpt":"Markdown in GitHub. WordPress as the publishing surface. Sync Markdown documentation into WordPress Pages as Gutenberg-compatible block content. Quick start 1. Put the Markdown documentation in docs/ . 2. Create a WordPress access token. 3. Add one of the GitHub Actions workflows below. 4. Run it first with status: draft and dry-run: true . The complete product and setup documentation lives at docs.press/docs. Optional WordPress packages You do not have to install the DocsPress theme. An unversioned DocsPress sync works with the site's existing theme and native WordPress blocks. - Download the latest DocsPress theme - Download the latest DocsPress Blocks plugin Install the theme for the complete documentation layout. Install the Blocks plugin for rich DocsPress blocks; it is required when API versioning is enabled. Preview local docs from the CLI Run this from the repository that contains your docs/ directory: WordPress Playground imports the Markdown as editable Pages and opens /docs/ . Playground examples - Default documentation site - Contextual sidebars - Versioned API documentation - Stock WordPress, no DocsPress theme or plugin The first two examples include the complete DocsPress presentation layer. The stock WordPress example installs neither optional package and shows repository Markdown as editable native Gutenberg blocks. GitHub Actions Publish Markdown to WordPress Create .github/workflows/sync-docs.yml : Review the Actions summary, then set dry-run: false . Publi","default_branch":null,"files":null,"tree":[],"storefront":"/r/Automattic","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Automattic/docspress/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}