The essentials2 min read

Writing with Markdown

Markdown keeps your words readable, even before they reach the browser. Here are the building blocks.

Give ideas a little structure

Use # for your page title, ## for sections, and ### for smaller ideas. Section headings automatically appear in the table of contents.

Keep it readable

A blank line makes a new paragraph. Use bold for emphasis, italics for a softer touch, and inline code for technical details.

Make a list

  • Begin with the idea that matters.
  • Give each thought a little room.
  • Keep going until it feels complete.

For a sequence, use a numbered list:

  1. Open a Markdown file.
  2. Write something useful.
  3. Save and see it appear.

Show your work

Fenced code blocks preserve your formatting:

const thought = 'Keep things simple.'
console.log(thought)

Connect the dots

Use [label](url) to add links. Connect to another page, a section with #make-a-list, or a website.

Images use ![description](/image.jpg). Place your images in public/ and use their path from the site root. Always include a useful description.

Compare a few things

Element Syntax Purpose
Heading ## Title Introduce a section
Bold **words** Emphasize an idea
Link [label](url) Connect to more
Quote > words Set a thought apart

There is no perfect first draft. There is only the next sentence.

Raw HTML is disabled to keep content safe and predictable.

A little more knowledge, a little further along.