index

Markdown Style Guide

This document serves as a comprehensive test suite for all markdown features supported by this theme.


Headings

H1 Heading

H2 Heading

H3 Heading

H4 Heading

H5 Heading
H6 Heading

Paragraphs

This is a paragraph with regular text. Paragraphs are separated by blank lines and can contain multiple sentences that flow naturally together.

This is a second paragraph. Multiple paragraphs help demonstrate spacing and typography consistency across the document.

Text Formatting

Bold text using double asterisks Bold text using double underscores

Italic text using single asterisks Italic text using single underscores

Bold and italic using triple asterisks Bold and italic using triple underscores

Strikethrough text using double tildes

Inline code using backticks

External link External link with title Internal link Reference-style link Link with nested bold text

Autolink: https://example.com Email: email@example.com

Images

Image with caption
Image with caption
_Hidden caption - starts with underscore

Blockquotes

Single line blockquote.

Multi-line blockquote. This continues on the next line. And one more line.

Blockquote with bold, italic, and code.

Nested blockquotes:

This is nested one level deep.

This is nested two levels deep.

Don’t communicate by sharing memory, share memory by communicating.

Rob Pike1

Lists

Ordered Lists

  1. First item
  2. Second item
  3. Third item
    1. Nested item 3.1
    2. Nested item 3.2
  4. Fourth item

Unordered Lists

  • Item one
  • Item two
  • Item three
    • Nested item
    • Another nested item
      • Deeply nested item
  • Item four

Mixed Lists

  1. Ordered item
    • Unordered subitem
    • Another unordered subitem
  2. Another ordered item
    1. Ordered subitem
    2. Another ordered subitem

Task Lists

  • Unchecked task
  • Checked task
  • Another unchecked task
    • Nested checked task
    • Nested unchecked task

Lists with Multiple Paragraphs

  1. First item

    This is a continuation of the first item.

  2. Second item

    This is a continuation of the second item.

    • Nested list item
    • Another nested item
  3. Third item

Code

Inline Code

Use const variable = value for declaring constants.

You can also escape backticks: `backtick` or ``double backtick``.

Code Blocks

Plain code block with no language:

No syntax highlighting here
Just plain text

JavaScript:

const greeting = 'Hello, World!'
console.log(greeting)

function add(a, b) {
  return a + b
}

TypeScript:

interface User {
  name: string
  age: number
}

const user: User = {
  name: 'John',
  age: 30
}

JSX/React:

const Button = ({ text, onClick }) => {
  const [count, setCount] = useState(0)

  const handleClick = () => {
    setCount(count + 1)
    onClick?.()
  }

  return (
    <button className="btn" onClick={handleClick}>
      {text} ({count})
    </button>
  )
}

Python:

def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

print(fibonacci(10))

CSS:

.container {
  display: flex;
  justify-content: center;
  align-items: center;
  gap: 1rem;
}

.button:hover {
  background-color: var(--primary-color);
  transform: scale(1.05);
}

Bash:

#!/bin/bash
echo "Hello, World!"

for i in {1..5}; do
  echo "Number: $i"
done

JSON:

{
  "name": "example",
  "version": "1.0.0",
  "dependencies": {
    "astro": "^5.0.0"
  }
}

Tables

Basic Table

Header 1Header 2Header 3
Row 1DataMore
Row 2DataMore

Aligned Tables

Left AlignedCenter AlignedRight Aligned
LeftCenterRight
TextTextText

Tables with Formatting

StyleWeightCodeLink
NormalRegularconstLink
ItalicBoldletLink

Horizontal Rules

Three or more dashes:


Three or more asterisks:


Three or more underscores:


HTML Elements

Subscript and Superscript

H2O is water.

Xn + Yn = Zn

Abbreviations

HTML is the standard markup language.

CSS is used for styling.

GIF is a bitmap image format.

Keyboard Input

Press Ctrl + C to copy.

Press Cmd + Shift + P to open command palette.

Press Alt + F4 to close window.

Mark/Highlight

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

This is highlighted text in a sentence.

Details/Summary

Click to expand

This content is hidden by default and revealed when clicked.

You can include markdown formatting and code here.

  • Lists work too
  • Another item

Other HTML Elements

Small text

Deleted text

Inserted text

Footnotes

Here’s a sentence with a footnote.2

This sentence has another footnote.3

Multiple references to the same footnote.2

Math Equations

Inline math: E=mc2E = mc^2

Inline equation: i=1ni=n(n+1)2\sum_{i=1}^{n} i = \frac{n(n+1)}{2}

Display math:

ex2dx=π\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}

Complex equation:

ddx(0xf(u)du)=f(x)\frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x)

Matrix:

[abcd]\begin{bmatrix} a & b \\ c & d \end{bmatrix}

Edge Cases

Escaping Characters

*Not italic* [Not a link](https://example.com) `Not code`

Backslash

Backslash: \

Special Characters

Copyright: © Registered: ® Trademark: ™ Em dash: — En dash: – Ellipsis: …

Empty Elements

Empty emphasis: ** ** Empty link: Empty code: “

URLs with Special Characters

Link with query params Link with anchor

Line Breaks

This is a line with a hard break created with two spaces.

This is a line
with a hard break
created with HTML.

Nested Formatting

Bold with italic inside

Italic with bold inside

Bold with code inside

Link with bold and italic text

Blockquote with bold, italic, and code

  • List item in blockquote
  • Another item with formatting

Long Content

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 nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.

Comments


Footnotes

  1. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015.

  2. This is the second footnote. 2

  3. This is a named footnote with a longer explanation. It can contain formatting and multiple sentences.