Docs are the articles in your help centre. You write them in the WordPress block editor, using standard blocks plus the PinkDocs blocks designed for documentation.
Create and publish a doc
Add a new doc
In your WordPress admin, go to PinkDocs → Add New Doc and enter a clear title that describes the task, for example "Changing your docs URL".
📷 Image placeholder: the block editor open on a new PinkDocs doc with the title filled in.
Write your content
Write your doc in the editor below the title. Use headings to split it into sections and the PinkDocs blocks below for steps, tips and questions.
Set the doc's details
Open the Settings sidebar on the right of the editor and choose the knowledge base, categories, excerpt, tags and order (see the table below).
📷 Image placeholder: the editor Settings sidebar showing the knowledge base, categories and excerpt panels.
Preview and publish
Click Preview to check how the doc looks, then click Publish and Publish again to confirm.
| Setting | What it does |
|---|---|
| Knowledge base | Chooses which help centre the doc belongs to. |
| Categories | Places the doc under one or more topics in the sidebar and on category pages. |
| Excerpt | A one-sentence summary shown in doc lists and search results. |
| Tags | Optional keywords that help readers find related docs. |
| Order | The doc's position in the sidebar. Lower numbers appear first. |
PinkDocs blocks for docs
Search for PinkDocs in the block inserter to find these blocks.
| Block | Use it for |
|---|---|
| Steps | Procedures readers follow in order. |
| Alert | Notes, tips, warnings and success messages. |
| Tabs | Alternatives readers choose between, such as hosting panels or operating systems. |
| Code block | Code, commands and config, with syntax highlighting and a copy button. |
| Multi-language code block | The same example in several languages. |
| FAQ | Expandable common questions. |
| Icon cards | Feature overviews and links to related guides. |
| Button | One clear call to action, such as a download. |
📷 Image placeholder: the block inserter showing the PinkDocs blocks.
Common questions
Yes. Tick more than one category in the Categories panel and the doc will appear in each of them.
Yes. Open the doc, make your changes and click Update. WordPress keeps previous versions in Revisions, so you can restore an earlier version at any time.