Skip to main content

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:

  1. First step
  2. Second step
    1. Sub-step one
    2. Sub-step two
  3. 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

PropertyTypeDefaultDescription
enabledbooleantrueEnable the feature
timeoutnumber3000Timeout in milliseconds
retriesnumber3Number of retry attempts
modestring"auto"Operating mode

Right-aligned numbers:

ComponentVersionDownloads
React18.2.01,234,567
Vue3.4.0987,654
Svelte4.2.0456,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.

note

This is a Docusaurus admonition note.

tip

This is a tip admonition.

info

This is an info admonition.

caution

This is a caution admonition.

danger

This is a danger admonition.


Images

Placeholder


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 $$

Footnotes

  1. This is the footnote content.