How to Markdown (MD) Tutorial

Markdown (MD) is a lightweight markup language used to format text in a simple and readable way. It’s widely used for documentation, README files, blogs, and notes.

Linking to Titles

You can link to any heading in your document using anchor links.

Headings automatically generate an ID based on their text (lowercased, spaces replaced with -).

Example:

[Jump to Text Formatting](#text-formatting)

Which becomes: Jump to Text Formatting

Headings

Headings are created using # symbols. More # means a smaller heading level.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Code Styling

Inline Code

Wrap text in backticks (`) to show inline code:

Example: `print(“Hello”)` → print("Hello")

Code Blocks

Use triple backticks for multi-line code blocks:

print("Hello World!")

You can specify a language for syntax highlighting:

echo "Hello from bash"

Supported languages include: bash, python, ruby, javascript, typescript, html, css, and json.

Text Formatting

**Bold** → Bold

*Italics* → Italics

***Both*** → Both

~~Strikethrough~~ → Strikethrough

Lists

Unordered Lists

Use -, +, or * before items:

- Item 1
- Item 2
  - Nested Item

Result:

  • Item 1
  • Item 2
    • Nested Item

Ordered Lists

Use numbers followed by a dot:

1. First
2. Second
3. Third

Result:

  1. First
  2. Second
  3. Third

Links & Images

[JPoore Portfolio](https://jpoore.dev.dev)

→ JPoore

Images

![Alt Text](https://www.image.com/example.jpg)

→ Alt Text

Or Alternatively you can use inline HTML with the Astro Renderer,

<img src="https://www.image.com/example.jpg" alt="drawing" width="200"/>
drawing

Blockquotes

Use > at the start of a line:

> This is a quote.

Result:

This is a quote.

Tables

Use | and - to create tables:

| Syntax | Description |
|--------|-------------|
| Header | Title       |
| Cell   | Content     |

Result:

SyntaxDescription
HeaderTitle
CellContent

Horizontal Rule

Use three or more -, *, or _:

---

Result:

Task Lists

Use - [ ] for unchecked and - [x] for checked:

- [x] Write tutorial
- [ ] Add more features

Result:

  • Write tutorial
  • Add more features

Escaping Characters

Use a backslash \ to escape Markdown formatting:

\*This will not be italicized\*

Result: *This will not be italicized*

Conclusion

Markdown makes writing simple and styled text easy. With just a few rules, you can create clean documents, notes, or entire websites.

Back to Top