Kitchen Sink
A preview of all documentation styles.
Typography
Headings
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Body Text
This is a regular paragraph with bold text, italic text, and bold italic text. Here's some inline code and a link to somewhere.
This is a second paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
Lists
Unordered list:
- First item
- Second item
- Nested item
- Another nested item
- Third item
Ordered list:
- First step
- Second step
- Sub-step one
- Sub-step two
- Third step
Task list:
- Completed task
- Incomplete task
- Another task
Code
Inline: Use npm install to install dependencies.
// JavaScript code block
function greet(name) {
console.log(`Hello, ${name}!`);
return true;
}
// Rust code block
fn main() {
println!("Hello, world!");
let x: i32 = 42;
}
# Shell commands
npm run build
git commit -m "Update styles"
Tables
| Property | Type | Default | Description |
|---|---|---|---|
enabled | boolean | true | Enable the feature |
timeout | number | 3000 | Timeout in milliseconds |
retries | number | 3 | Number of retry attempts |
mode | string | "auto" | Operating mode |
Right-aligned numbers:
| Component | Version | Downloads |
|---|---|---|
| React | 18.2.0 | 1,234,567 |
| Vue | 3.4.0 | 987,654 |
| Svelte | 4.2.0 | 456,789 |
Blockquotes
This is a simple blockquote. It can span multiple lines and contain formatted text.
Note: This is a note-style blockquote with a bold prefix.
This is a Docusaurus admonition note.
This is a tip admonition.
This is an info admonition.
This is a caution admonition.
This is a danger admonition.
Images
Horizontal Rules
Above the line.
Below the line.
Another style.
Details/Accordion
Click to expand
This is hidden content that appears when you expand the details element.
- It can contain lists
- And other formatted content
- Including
code
Definition List (HTML)
- Term 1
- Definition for term 1
- Term 2
- Definition for term 2
Keyboard Shortcuts
Press Ctrl + C to copy.
Press Cmd + Shift + P to open command palette.
Footnotes
Here's a sentence with a footnote1.
Math (if enabled)
Inline math: $E = mc^2$
Block math:
$$ \sum_{i=1}^{n} x_i = x_1 + x_2 + \cdots + x_n $$