Code Groups
Show the same concept in different languages or package managers.
Note
Code groups support all code block features including line numbers, highlighting, and markers.
Basic Usage
npm install docyard
Language Icons
Icons are automatically detected from the code block language:
const name = "Docyard";
console.log(`Hello, ${name}!`);
With Filenames
Use descriptive filenames as labels:
title: My Docs
description: Documentation for my project
branding:
color: "#3b82f6"
With Code Block Features
Combine with line numbers, highlighting, and markers:
export default {
title: "My Docs",
description: "Documentation site"
}
const greeting = "Hello, " + name;
const greeting = `Hello, ${name}!`;
Synced Groups
Code groups with identical labels stay in sync across the page:
npm install
npm run build
Click a tab in one group and all matching tabs switch together.
Code Groups vs Tabs
Use Code Groups when showing:
- Same code in different languages
- Same command for different package managers
- Alternative implementations
Use Tabs when showing:
- Different types of content (text, config, examples)
- Platform-specific instructions with prose
- Content that isn’t just code
Syntax
:::code-group
```language [Label]
code here
```
```language [Label]:line-numbers {1,3}
code with features
```
:::
Reference
| Feature | Syntax | Description |
|---|---|---|
| Container | :::code-group |
Required. Wraps code blocks |
| Label | [Label] |
Required. Tab label after language |
| Language | ` ```language ` | Optional. Syntax highlighting and auto-icon |
See Code Blocks for line numbers, highlighting, and marker syntax.
Edit this page
Last updated
Was this page helpful?
Thanks for your feedback!