Skip to content

🚀 MCP Integration is now live Learn More

Ctrl K

esc to close

to navigate

to select

Type to search documentation...

Home
Docs
Pricing
Changelog
Roadmap

Dark Mode

No articles found

Introduction
System requirements
Installing and activating PinkDocs
Creating your first knowledge base
Creating categories
Writing and publishing your first doc
PinkDocs blocks reference
Gutenberg and PinkDocs blocks showcase
Doc statuses: draft, pending, private and scheduled
Adding your help centre to your site menu

Colours, fonts and branding
Choosing a layout for your docs homepage
Customising the doc page: sidebar, table of contents and navigation
Customising category pages
Adding widgets beside the table of contents
Changing the docs URL and permalinks
Adding custom CSS
Overriding PinkDocs templates in your theme

Organising categories and subcategories
Ordering docs and categories
Using tags
Live search
Collecting "Was this helpful?" feedback
Changelog tabs: separate changelogs for Free, Pro and more
Publishing a changelog
Publishing a roadmap with voting, comments and email alerts
Analytics: traffic, search and engagement
Finding failed searches
Managing multiple knowledge bases
Restricting access to docs by login or user role

Write API reference docs
Import an OpenAPI file
POSTSample: Create a ticket
GETSample: List tickets
DELSample: Delete a ticket

Overview of PinkDocs AI features
Connecting an AI provider
Setting up the AI assistant chat
How the AI assistant finds answers in your docs
AI analytics: questions asked and answer rate
Finding content gaps from unanswered questions
Connecting PinkDocs to Claude and other AI tools (MCP)
Reviewing AI-suggested changes to docs
Generate featured images with AI
AI crawler analytics
Optimise your docs for AI crawlers
AI privacy and data handling

Frequently asked questions
Troubleshooting common issues
Getting support
Importing docs from another plugin
Exporting and backing up your docs
Translating PinkDocs and multilingual sites
Uninstalling PinkDocs

2026 PinkDocs | All rights reserved

Docs /developers

On this page

Share

Docs / developers

Tag

developers

1 article
Updated October 8, 2026

Articles

Write API reference docs Document your REST API with the PinkDocs API blocks: endpoint badges, parameter lists, request examples in several languages, response examples and a… 9 min read October 8, 2026

No articles match this filter.

AI Assistant

Hi, how can I help.

Try asking about

Loading...

Write API reference docs Listen

00:00 00:00