Markdown Guide
Guide | January 1, 2024
Markdown Guide
A complete reference for writing Markdown in your blog posts.
Headings
Use ## for main sections and ### for subsections. The table of contents on the right side of each post is automatically generated from your ## and ### headings.
## Section Title
### Subsection Title
Note: Avoid using
#(h1) in your post body -- the post title from frontmatter is already rendered as h1.
Text Formatting
You can format text in several ways:
- Bold text with
**double asterisks** - Italic text with
*single asterisks* Strikethroughwith~~double tildes~~Inline codewith`backticks`- Bold and italic with
**_combined_**
Lists
Unordered Lists
- First item
- Second item
- Nested item
- Another nested item
- Deeply nested
- Third item
Ordered Lists
- First step
- Second step
- Third step
- Sub-step A
- Sub-step B
Task Lists
- Set up the project
- Write the first post
- Add more content
- Deploy to production
Blockquotes
This is a blockquote. Use it for callouts, notes, or highlighting important information.
You can also have multi-paragraph blockquotes.
Just keep using
>on each line.
Links
Regular links work as expected:
External links automatically open in a new tab.
Images
Place images in the public/posts/ directory and reference them:

Or use a full URL for external images:

Tables
| Feature | Status | Notes |
|---|---|---|
| Dark mode | Supported | Automatic toggle |
| MDX | Supported | React components |
| RSS | Supported | Auto-generated |
| Search | Supported | Full-text search |
Align columns with colons:
| Left | Center | Right |
| :----- | :-----: | -----: |
| text | text | text |
Horizontal Rules
Separate sections with a horizontal rule:
Use three dashes --- on their own line.
Code Blocks
Specify a language for syntax highlighting:
JavaScript
function greet(name) {
return `Hello, ${name}!`;
}
console.log(greet("World"));
Python
def fibonacci(n):
a, b = 0, 1
for _ in range(n):
yield a
a, b = b, a + b
for num in fibonacci(10):
print(num)
CSS
:root {
--primary: #2563eb;
--background: #ffffff;
}
body {
font-family: system-ui, sans-serif;
color: var(--primary);
background: var(--background);
}
Line Highlighting
Highlight specific lines by adding {lines} after the language identifier:
```typescript {3,5-7}
// line 3 and lines 5-7 will be highlighted
```
Footnotes
You can add footnotes for additional context1.
They are rendered at the bottom of the post2.