docs-content-widgetslisted
Install: claude install-skill Docsbook-io/docs-skills
# docs-content-widgets — Rich Blocks Inside Markdown
## The idea
A content widget marks a region of **ordinary markdown** to be rendered as a UI block:
```markdown
<!-- widget:cards -->
## Start Here
- [Overview](./overview.md) — What this product is and why it matters {compass}
- [Getting Started](./quick-start.md) — How to begin in 3 minutes {rocket}
<!-- /widget -->
```
Two properties make this safe to use anywhere:
- **The source stays plain markdown.** HTML comments are invisible in every markdown reader — on GitHub, in an editor preview, in `cat`. A reader who never sees the rendered site still sees a correct, complete page with the same headings and the same links.
- **It degrades, never hides.** An unknown widget name, a missing closing marker, or a renderer that doesn't exist yet leaves the content as normal markdown. Nothing between the markers can ever disappear from the page.
Never put JSON, YAML, or configuration between the markers. The region must read as meaningful prose on its own — the widget is a presentation upgrade applied on top, not a data format.
## Workflow
1. **Get the live catalog.** Call `list_content_widgets` if a Docsbook MCP connection is available — it returns every widget with its exact markdown contract and a copy-pasteable example. This is the source of truth; widget names and contracts change as renderers are added. Without MCP, use the reference table below and expect it to lag.
2. **Find candidate pages.** Look for the two shap