Docs template
Code:docs
Docs mirrors documentation IA with breadcrumbs, structured typography, and a bottom accent stripe.
Layout anatomy
- Breadcrumb trail across the top (derived from
brand,division, andtitle). - Left-aligned headline with a slim description area under it.
- Bottom color strip that inherits
primaryColor. - Optional icon slot referenced from
image.
Best for
- API references and tutorial hubs.
- Changelog or release documentation.
- Knowledge base articles that need clear context.
Recommended parameters
| Parameter | Purpose |
|---|---|
brand | Root breadcrumb (e.g., “Docs” or product name). |
division | Section breadcrumb (“API”, “Guides”). |
title | Final breadcrumb + main headline. |
desc | Summary of the article or endpoint. |
primaryColor | Footer strip + accent color. |
Example URL
To highlight a code-heavy article, pass mode=dark and pair with a monochrome primaryColor. The breadcrumb automatically adjusts its contrast for readability.