Markdown
Stardust uses standard Markdown with some powerful extensions. If you're familiar with GitHub-flavored Markdown, you'll feel right at home.
Basic Syntax
Headings
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
â ī¸ Warning
Only use one # Heading 1 per page â this becomes the page title.
Text Formatting
**Bold text**
*Italic text*
~~Strikethrough~~
`Inline code`
Links
[External link](https://example.com)
[Internal link](/getting-started)
[Link with title](https://example.com "Title text")
Images
đĄ Tip
Place images in the public/ directory and reference them with absolute paths like /images/screenshot.png.
Lists
Unordered lists:
- Item one
- Item two
- Nested item
- Another nested item
- Item three
Ordered lists:
1. First item
2. Second item
3. Third item
Blockquotes
> This is a blockquote.
> It can span multiple lines.
This is a blockquote. It can span multiple lines.
Code Blocks
Fenced Code Blocks
Use triple backticks with an optional language identifier:
```dart
void main() {
print('Hello, Stardust!');
}
```
Renders as:
void main() {
print('Hello, Stardust!');
}
Supported Languages
Stardust supports syntax highlighting for 100+ languages including:
- Dart
- JavaScript/TypeScript
- Python
- Go
- Rust
- Java
- C/C++
- Ruby
- PHP
- Swift
- Kotlin
- SQL
- YAML/JSON
- Bash/Shell
Code Block Titles
Add a title to code blocks using the title attribute:
```dart title="main.dart"
void main() => runApp(MyApp());
```
Tables
| Feature | Stardust | Others |
|---------|----------|--------|
| Zero config | â
| â |
| Dart-native | â
| â |
| Fast builds | â
| â ī¸ |
Renders as:
| Feature | Stardust | Others |
|---|---|---|
| Zero config | â | â |
| Dart-native | â | â |
| Fast builds | â | â ī¸ |
Table Alignment
| Left | Center | Right |
|:-----|:------:|------:|
| L | C | R |
Horizontal Rules
---
JSX-Style Components
Stardust extends Markdown with JSX-style components:
<Info>
This is an informational callout.
</Info>
<Tabs>
<Tab name="JavaScript">console.log('Hello')</Tab>
<Tab name="Python">print('Hello')</Tab>
</Tabs>
Info
Components must be on their own lines with blank lines before and after.
See the Components section for the full component library.
HTML in Markdown
You can use raw HTML when needed:
<div style="text-align: center">
Centered content
</div>
â ī¸ Warning
Avoid inline styles when possible. Use Stardust's built-in components for consistent styling.
Escaping
Use backslashes to escape special characters:
\*Not italic\*
\`Not code\`
\# Not a heading