Open-source documentation light
A bright documentation portal with durable navigation, readable code, contribution paths, and version context.
- Revision
- 1
- Verified
- 2026-07-26
Compatibility and paths
DESIGN.mdReference it from AGENTS.md.DESIGN.mdImport it from CLAUDE.md.DESIGN.mdReference it from GEMINI.md.Trust and provenance
Curated record reviewed 2026-07-26. Results still depend on the supplied context and target environment.
See the design before you give it to an agent
This sandboxed preview is rendered directly from the same DesignBrief embedded in the downloadable DESIGN.md.
What this preset defines
The file gives an agent concrete design constraints instead of a vague request to “make it look good.”
- Product
- documentation
- Layout archetype
- documentation
- Density
- comfortable
- Base radius
- 6px
- Type scale
- 1.2
#ffffffsurface#f6f8fatext#1f2328muted#636c76accent#0969dasuccess#1a7f37warning#9a6700danger#cf222eRequired layout sections
- Get started
- Concepts
- API reference
- Examples
- Migration
- Contribute
How to use it
The preset is useful without AI and does not execute code.
- 01Preview and customize
Check desktop and mobile, then open the visual builder if the palette, typography, spacing, or sections need adjustment.
- 02Download DESIGN.md
Save it in the repository root. It contains readable design rules plus the versioned machine-readable DesignBrief.
- 03Connect your agent
Add the generated integration snippet to AGENTS.md, CLAUDE.md, or GEMINI.md so the agent explicitly reads the design system.
DESIGN.md is a OneLiners convention. The included integration file explains exactly how to use it with your selected agent.
Start with DESIGN.md, then take only the extras you need
The main download is human-readable Markdown. JSON is available only as an optional design-token file.
Product direction, semantic palette, typography, layout, responsive behavior, accessibility, and an importable DesignBrief.
3465 bytes · MarkdownView generated DESIGN.md
# Open-source documentation light
## Product direction
- **Page type:** documentation
- **Layout archetype:** documentation
- **Audience:** Developers adopting and contributing to an open-source project
- **Goal:** Move readers from first concept to a working integration quickly.
- **Tone:** Open, practical, and precise
## Visual system
- Use the semantic palette below; never use color without meaning.
- Heading: Inter, ui-sans-serif, system-ui, sans-serif; body: Inter, ui-sans-serif, system-ui, sans-serif; code: JetBrains Mono, ui-monospace, monospace.
- Density is comfortable; base radius is 6px; shadows are subtle.
- Icons: Lucide-style outline icons with consistent 1.75px strokes.
- Imagery: Use product-specific imagery only when it explains the workflow; never use decorative filler..
## Semantic palette
| Role | Value | Intended use |
| --- | --- | --- |
| Background | `#ffffff` | Page canvas and the deepest application layer |
| Surface | `#f6f8fa` | Cards, panels, navigation, and raised regions |
| Text | `#1f2328` | Primary copy, labels, and high-emphasis content |
| Muted | `#636c76` | Secondary copy, metadata, and inactive controls |
| Accent | `#0969da` | Primary actions, focus, selection, and active state |
| Success | `#1a7f37` | Confirmed success and healthy state |
| Warning | `#9a6700` | Caution, pending review, and non-blocking risk |
| Danger | `#cf222e` | Errors, destructive actions, and blocking risk |
The optional `design-tokens.css` from the full export pack mirrors these values. This `DESIGN.md` remains complete when used on its own.
## Layout and content
1. Get started
2. Concepts
3. API reference
4. Examples
5. Migration
6. Contribute
## Responsive and accessibility
- Collapse sidebars into an explicit drawer and preserve the primary task before secondary metadata..
- Meet WCAG AA contrast, preserve visible focus, and respect reduced motion.
- Do not reduce essential content or actions on mobile.
## Machine-readable OneLiners DesignBrief
<!-- oneliners-design-brief:v1 -->
```json
{
"schemaVersion": "1",
"name": "Open-source documentation light",
"pageType": "documentation",
"layoutStyle": "documentation",
"audience": "Developers adopting and contributing to an open-source project",
"goal": "Move readers from first concept to a working integration quickly.",
"tone": "Open, practical, and precise",
"palette": {
"background": "#ffffff",
"surface": "#f6f8fa",
"text": "#1f2328",
"muted": "#636c76",
"accent": "#0969da",
"success": "#1a7f37",
"warning": "#9a6700",
"danger": "#cf222e"
},
"typography": {
"heading": "Inter, ui-sans-serif, system-ui, sans-serif",
"body": "Inter, ui-sans-serif, system-ui, sans-serif",
"mono": "JetBrains Mono, ui-monospace, monospace",
"baseSize": 16,
"scale": 1.2
},
"density": "comfortable",
"radius": 6,
"shadow": "subtle",
"sections": [
"Get started",
"Concepts",
"API reference",
"Examples",
"Migration",
"Contribute"
],
"iconStyle": "Lucide-style outline icons with consistent 1.75px strokes",
"imagery": "Use product-specific imagery only when it explains the workflow; never use decorative filler.",
"mobileStrategy": "Collapse sidebars into an explicit drawer and preserve the primary task before secondary metadata.",
"accessibility": {
"contrastTarget": "WCAG AA",
"reducedMotion": true,
"visibleFocus": true
}
}
```
Real example
Input
documentation: Move readers from first concept to a working integration quickly.
Expected result
A comfortable documentation using #0969da as the semantic accent and 6 defined sections.