
Formatting Reference
This post demonstrates all the markdown, extended markdown, and other embed features available in Astro Modular. Use this as both a reference guide and a showcase of what’s possible.
Basic Formatting
Text Emphasis
- Bold text using
**bold**
or__bold__
- Italic text using
*italic*
or_italic_
- Bold and italic using
***text***
Strikethroughusing~~text~~
- Highlighted text using
==text==
Inline code
using backticks
Headings
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Callouts and Admonitions
Our theme supports Obsidian-style callouts with proper icons and styling. Each callout type has its own color scheme and matching Lucide icon.
Basic Callouts
This is a note callout. Use it for general information that readers should be aware of.
This is a tip callout. Perfect for helpful suggestions and best practices.
This is an important callout. Use it to highlight critical information.
This is a warning callout. Use it to alert readers about potential issues.
This is a caution callout. Use it for dangerous or risky situations.
Custom Titles
You can customize the title of any callout by adding text after the callout type.
Custom titles help you provide more context for your callouts.
Collapsible Callouts
You can make callouts collapsible by adding +
(expanded by default) or -
(collapsed by default) after the callout type:
This callout starts expanded and can be collapsed by clicking the toggle button or the title.
You can combine collapsible functionality with custom titles for more control over your content organization.
Extended Callout Types
Info callouts provide additional context or details.
Success callouts highlight positive outcomes or achievements.
Question callouts can be used to pose questions or highlight areas of uncertainty.
Example callouts are perfect for showcasing code examples or demonstrations.
Quote callouts can be used to highlight important quotes or references.
Media Content
Images
Single Image With Caption
Photo by Antoine Rault on Unsplash
Multiple Image Layouts
This theme automatically arranges consecutive images in responsive grid layouts based on the number of images. Images can be placed together without empty lines between them to create these layouts.
Two Images Side by Side
Three Images in a Row
Four Images in a Row
How to Use Multiple Images / Gallery
Simply place multiple images together without empty lines between them:



On mobile devices, all layouts switch to a single column for better readability.
Video Files
Video files are embedded as HTML5 video players with controls and responsive design.
YouTube Videos
YouTube videos are automatically embedded with responsive design and optimized settings.
Audio Files
Audio files are embedded as HTML5 audio players with controls and filename display.
PDF Documents
PDFs are embedded as inline viewers with download links.
Use ![[attachments/document.pdf#page=3]]
to select a specific PDF page to display.
Twitter/X Posts
Twitter posts are embedded with theme-aware styling that matches your site’s light/dark mode.
Buttons
These buttons use your existing color palette and adapt perfectly to light/dark themes. Wrap them in internal or external links if you prefer:
<div class="btn-group-center my-8">
<a href="https://google.com" class="no-styling no-underline" target="_blank"><button class="btn btn-primary">Primary Action</button></a>
<a href="https://google.com" class="no-styling no-underline" target="_blank"><button class="btn btn-secondary">Secondary</button></a>
<a href="https://google.com" class="no-styling no-underline" target="_blank"><button class="btn btn-outline">Outlined</button></a>
<a href="https://google.com" class="no-styling no-underline" target="_blank"><button class="btn btn-ghost">Subtle</button></a>
</div>
Lists
Unordered Lists
- First item
- Second item
- Nested item
- Another nested item
- Deeply nested item
- Third item
Ordered Lists
- First step
- Second step
- Sub-step A
- Sub-step B
- Sub-sub-step
- Third step
Task Lists
- Completed task
- Incomplete task
- Another completed task
- Nested incomplete task
- Nested completed task
- Final incomplete task
Links and References
External Links
Here’s an external link.
Internal Links
You can create internal links using double brackets (wikilinks) or with standard markdown.
For example: Getting Started or Astro Suite Obsidian Vault Guide (Astro Modular).
For example: [[getting-started|Getting Started]] or [Astro Suite Vault (Modular) Guide](astro-suite-vault-modular-guide).
Here’s an internal link with an anchor: [[sample-folder-based-post/index#Benefits of Folder-Based Approach|Benefits of Folder-Based Approach]]
Here’s a relative link: Mermaid Diagram Test
Reference Links
This is a reference link and this is another reference link.
Linked Images
[](https://obsidian.md)
Mathematical Notation
This theme includes comprehensive LaTeX math support using KaTeX for fast, client-side rendering. All math works seamlessly in both light and dark themes.
Inline Math
Use single dollar signs for inline math: or .
Display Math
Use double dollar signs for centered display math:
Common Mathematical Notation
Fractions and Superscripts
- Fractions: ,
- Superscripts: ,
- Subscripts: ,
Greek Letters
Mathematical Symbols
- Summation:
- Product:
- Integral:
- Limit:
Matrices and Vectors
Complex Equations
Math in Callouts
Math works perfectly within callouts:
The Pythagorean theorem states that for a right triangle:
Where is the hypotenuse and and are the other two sides.
The formula for integration by parts is:
This is particularly useful for integrals involving products of functions.
Advanced Mathematical Typesetting
Aligned Equations
Cases and Piecewise Functions
Set Notation
- Natural numbers:
- Real numbers:
- Complex numbers:
- Set union:
- Set intersection:
- Subset:
Math with Text
You can mix math with regular text seamlessly. For example, the quadratic formula is , which gives us the roots of any quadratic equation .
Obsidian Compatibility
All math notation works identically in Obsidian and your published blog:
- Inline math:
$...$
syntax - Display math:
$$...$$
syntax - LaTeX commands: Full support for standard LaTeX math commands
- Greek letters: Use
\alpha
,\beta
, etc. - Symbols: Use
\sum
,\int
,\infty
, etc.
Code Blocks
Inline Code
Use const variable = 'value'
for inline code snippets.
JavaScript
function greetUser(name) {
console.log(`Hello, ${name}!`);
return `Welcome to our blog, ${name}`;
}
const user = "Developer";
greetUser(user);
Python
def calculate_fibonacci(n):
"""Calculate the nth Fibonacci number."""
if n <= 1:
return n
return calculate_fibonacci(n-1) + calculate_fibonacci(n-2)
# Example usage
for i in range(10):
print(f"F({i}) = {calculate_fibonacci(i)}")
CSS
.button {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
border: none;
border-radius: 8px;
color: white;
padding: 12px 24px;
transition: transform 0.2s ease;
}
.button:hover {
transform: translateY(-2px);
}
Bash/Shell
#!/bin/bash
echo "Setting up development environment..."
# Install dependencies
npm install
# Start development server
npm run dev
echo "Development server started on http://localhost:3000"
Tables
Basic Tables
Feature | Supported | Notes |
---|---|---|
Markdown | ✅ | Full CommonMark support |
Wikilinks | ✅ | Obsidian-style double brackets |
Callouts | ✅ | Multiple types with icons |
Math | ✅ | LaTeX math with KaTeX rendering |
Diagrams | ✅ | Mermaid diagram support |
Advanced Tables
Language | Use Case | Performance | Learning Curve |
---|---|---|---|
JavaScript | Web Development | ⭐⭐⭐⭐ | Easy |
Python | Data Science | ⭐⭐⭐ | Easy |
Rust | Systems Programming | ⭐⭐⭐⭐⭐ | Hard |
Go | Backend Services | ⭐⭐⭐⭐ | Medium |
Blockquotes
Simple Quotes
The best way to predict the future is to invent it. — Alan Kay
Nested Quotes
This is a top-level quote.
This is a nested quote within the first quote.
And this is a quote nested even deeper.
Back to the top level.
Horizontal Rules
You can create horizontal rules using three dashes:
Or three asterisks:
Or three underscores:
Keyboard Shortcuts
Press Ctrl + C to copy and Ctrl + V to paste.
Use Cmd + K to open the command palette.
Special Characters and Symbols
- Copyright: ©
- Trademark: ™
- Registered: ®
- Arrows: ← ↑ → ↓ ↔ ↕
- Symbols: ★ ☆ ♠ ♣ ♥ ♦
- Currency: $ € £ ¥
HTML Elements
Sometimes you need to use HTML for more complex formatting:
Click to expand
This content is hidden by default and can be expanded by clicking the summary.
Small text for fine print
Works with Obsidian
All of these formatting options should also appear in Obsidian, with some differences depending on the theme you use.
Quick Reference
- Bold:
**text**
or__text__
- Italic:
*text*
or_text_
- Code:
`code`
- Highlight:
==text==
- Links:
[text](url)
or[[wikilink]]
- Images:

- Lists:
-
or1.
for ordered - Tasks:
- [ ]
and- [x]
- Tables: Use
|
to separate columns - Quotes: Start lines with
>
- Callouts:
> [!TYPE]
- Horizontal rule:
---
Happy writing!
Getting Started
...## Next Steps 1. **Customize** `src/config.ts` 2. **Write** your first post 3. **Explore** [[Formatting Reference]] 4. **Set up** Obsidian vault workflow 5. **Deploy** and share Your modular Astro blog is ready...