Category pages list every doc in a category. Readers reach them from your docs homepage, the sidebar and breadcrumbs. Make them useful by writing clear descriptions and ordering docs in a logical reading path.
📷 Image placeholder: a category page showing the category name, description and list of docs.
What a category page shows
- The category name as the page heading
- The category description under the heading
- Every published doc in the category, in sidebar order, with its excerpt
- Any subcategories and their docs
Improve a category page
Write a clear description
Go to PinkDocs → Categories, click Edit on the category and write one sentence that names the tasks covered. For example: Install PinkDocs, create your first knowledge base and publish your first doc.
📷 Image placeholder: the Edit Category screen with the description field highlighted.
Add excerpts to each doc
Open each doc in the category and fill in the Excerpt in the Settings sidebar. Excerpts appear under each doc title on the category page.
Order the docs
Set each doc's Order so the category reads from basic to advanced tasks.
Check the page
Open the category on your site and read it from top to bottom as a new reader would.
Use subcategories for large categories
When a category grows beyond 10–15 docs, split it into subcategories. For example, split Features into Content, Search and Analytics.
Create the subcategory
Go to PinkDocs → Categories, enter a name and choose the existing category as its Parent.
Move the docs
Open each doc and tick the new subcategory in the Categories panel.
Common questions
Categories only appear once they contain at least one published doc. Check that the docs are published and assigned to the category.
Yes. Edit the category and change its Slug. Update any links that point to the old URL.