Custom Interactive Containers
Standard Markdown excels at basic text formatting, but professional technical documentation requires rich structural components to effectively communicate complex logic. docmd extends Markdown with a suite of isomorphic containers that render into responsive, high-fidelity UI elements.
Block Syntax Reference
All containers utilize a consistent block syntax, ensuring a predictable authoring experience across your entire project.
::: type "Optional Header Title"
This is the primary content area.
It supports **Markdown**, imagery, and deep component nesting.
:::
| Component | Keyword | Primary Use Case |
|---|---|---|
| Callouts | callout |
Semantic highlights for tips, warnings, and alerts. |
| Cards | card |
Framed structural blocks for feature grids and layout control. |
| Grids | grids |
Auto-adjusting multi-column structural groups. |
| Tabs | tabs |
Interactive switchable panes for alternative platform instructions. |
| Steps | steps |
Visual numbered timelines for “How-to” guides and tutorials. |
| Buttons | button |
Self-closing, prominent call-to-action navigation links. |
| Collapsibles | collapsible |
Interactive accordion toggles for FAQs and deep-dive technical data. |
| Changelogs | changelog |
Structured, timeline-based version history and release notes. |
The Strategic Importance of Containers
Containers facilitate more than visual polish; they provide high-fidelity Semantic Signals to the docmd engine and downstream AI agents:
- AI Context Mapping: Marking a block as a
callout warningexplicitly tells LLMs to prioritize that information during its reasoning and generation phases. - Structural Integrity: Combining
cardswith standard CSS allows for the creation of sophisticated landing pages without ever leaving the Markdown environment. - Source Maintainability: Eliminates “HTML Bloat” in your documentation source, keeping your
.mdfiles clean and machine-readable.
Recursive Composition
docmd supports Infinite Nesting Depth. You can compose any container within another to build complex, interactive documentation nodes purely with minimalist Markdown syntax.
::: card "Architecture Overview"
::: callout info
This module utilizes an asynchronous I/O pipeline.
:::
::: button "Deep Dive into Core Engine" /advanced/developer-guide
:::