How to use markdown and MDX

Dec 21, 2021 - Last update: Dec 9, 2024

Introduction

Back in 2021 I decided to set up a digital garden. I wrote my markdown notes using the Obsidian editor. Utilizing markdown not only simplifies text formatting but also provides a lot of flexibility and control over my notes. Obsidian has some good documentation available on the basic formatting syntax and the advanced formatting syntax.

This website has been running since the end of 2024 using Astro Starlight and I am also using the MDX syntax.

Quick List

Headings: Use #, ##, ### for different levels of headings.
```
# Main Heading
## Subheading
### Sub-subheading
```
Bold and Italics:
- Italics: *italics* or _italics_
- Bold: **bold** or __bold__
- Bold and Italics: ***bold and italics***
Strikethrough and Underline:
- ~~strikethrough~~: ~~strikethrough~~
- underline: <u>underline</u>
Highlight:
- Highlight: <mark>Highlight</mark> or ==Highlight==
Lists:
- Unordered list: Use -, *, or +
```
- Item 1
- Item 2
  - Subitem
```
- Ordered list: Use numbers followed by a period
```
1. First item
2. Second item
```
Links:
```
[Text](URL)
```
Checkbox:
```
- [ ]
```
Images:
```
![Alt text](URL of the image)
```
Code Blocks: Use three backticks ``` before and after the code block. You can indicate the programming language being used after the opening backticks.
```
```js
def hello_world():
    print("Hello, world!")
```
```
Blockquote:
```
> This is a quote.
```

Favorites

Obsidian Editing and Formatting

Astro Starlight Guide

MDX Syntax

Comments

No comments found for this note.

Join the discussion for this note on Github. Comments appear on this page instantly.