Return to Archive
— · —

Markdown Guide

This page demonstrates the Markdown features and site-specific styling. Use it as a reference when writing content.

Headings

H1

H2

H3

H4

H5
H6

Paragraph

This is a paragraph with inline elements: emphasis with italics, strong with bold, inline code, and a link.

Images

Example:

Alt text

Blockquotes

Without attribution

Tiam, ad mint andaepu dandae nostion secatur sequo quae.
You can use Markdown syntax within a blockquote.

With attribution

Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike1

Tables

ColumnItalicsBoldCode
Aitalicsboldcode

Code Blocks

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>Test</p>
  </body>
</html>
echo "Hello, world"
export function greet(name) {
  return `Hello, ${name}!`
}
console.log(greet('world'))
---
import { SITE_TITLE } from '../consts';
---
<section>
  <h1>{SITE_TITLE}</h1>
  <p>Astro component example.</p>
</section>

List Types

Ordered

  1. First item
  2. Second item
  3. Third item

Unordered

  • List item
  • Another item
  • And another item

Nested

  • Fruit
    • Apple
    • Orange
    • Banana
  • Dairy
    • Milk
    • Cheese

Other Elements — abbr, sub, sup, kbd, mark

GIF is a bitmap image format.

H2O

Xn + Yn = Zn

Press CTRL+ALT+Delete to end the session.

Most salamanders are nocturnal.

Math

Inline math: E=mc2E = mc^2.

Block math:

∫0πsin⁡(x) dx=2\int_{0}^{\pi} \sin(x)\,dx = 2

Blockquote Examples

Example quote: “Security is a process, not a product.”

— Bruce Schneier

“The quieter you become, the more you are able to hear.”

Admonitions with blockquote syntax

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

Footnotes

  1. Excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩