Markdown guide

Markdown syntax reference

The complete syntax at a glance. On the left is what you type; on the right is what Markdown Viewer renders. Everything here is GitHub-Flavored Markdown and works in the editor above.

• Headings

  # Heading 1
  ## Heading 2
  ### Heading 3

  Heading 1

  Heading 2

  Heading 3

• Bold and italic

  **Bold**   *Italic*   ***Both***

  Bold Italic Both

• Strikethrough

  ~~Strikethrough~~

  Strikethrough

• Link

  [Link text](https://example.com)

  Link text

• Image

  ![Markdown Viewer logo](/favicon.svg)

  Markdown Viewer logo

• Bullet list

  - First item
  - Second item
    - Nested item

  • First item
  • Second item
    • Nested item

• Numbered list

  1. First step
  2. Second step

  1. First step
  2. Second step

• Task list

  - [x] Rendered
  - [ ] Still to do

  • Rendered
  • Still to do

• Blockquote

  > A thoughtful quote

  A thoughtful quote

• Inline code

  Run `npm run dev` to start.

  Run npm run dev to start.

• Code block

  ```ts
  const greet = (name: string) =>
    `Hello ${name}`;
  ```

  const greet = (name: string) =>
    `Hello ${name}`;

• Table

  | Feature | Supported |
  | ------- | :-------: |
  | Tables  |    yes    |

  Feature	Supported
  Tables	yes

• Horizontal rule

  ---

  ---

• Footnote

  A claim that needs a source.[^1]
  
  [^1]: The source itself.

  A claim that needs a source.¹

  ¹ The source itself.

• Math

  Inline $E = mc^2$ or display:
  
  $$
  \int_0^1 x^2 \, dx
  $$

  E = mc²

  ∫₀¹ x² dx

• Mermaid diagram

  ```mermaid
  graph LR
    A[Write] --> B[Preview]
  ```