Code Blocks & Highlighting
docmd uses the fast lite-hl engine for native syntax highlighting. Specify the language identifier on every fenced block to apply appropriate lexical rules.
Syntax Highlighting
Declare the language identifier after the opening fence delimiter:
```typescript
async function build(config: string): Promise<void> {
await initialise(config);
}
```
async function build(config: string): Promise<void> {
await initialise(config);
}
Code Block Titles
Supply a double-quoted filename string after the language tag to render a styled title bar above the code container:
```json "docmd.config.json"
{
"title": "My Documentation",
"src": "docs/"
}
```
docmd.config.json
{
"title": "My Documentation",
"src": "docs/"
}
Supported Languages
docmd supports popular programming languages and data formats out of the box:
- Programming:
javascript,typescript,python,rust,go,ruby,csharp,c,cpp - Web Languages:
html,css,markdown - Data & Shell:
json,yaml,bash,powershell,dockerfile,toml - Diagrams & Logs:
mermaid,changelog
AI Context Strategy
When writing code snippets for human readers and AI agents:
- Explicit Language Tags: Use explicit language identifiers (
typescript,bash,json) rather than relying on auto-detection to ensure accurate tokenization forllms.txt. - Explanatory Inline Comments: Use inline comments to explain architectural decisions and non-obvious logic.
One-Click Copy Utilities
Enable theme.copyCode: true in docmd.config.json to display interactive copy-to-clipboard buttons on code block headers.