Writing in Markdown
updated
Meldoc uses Markdown for all content. If you’ve ever written a GitHub README, you already know the basics.
Text formatting
You can make text bold, italic, strikethrough, or use inline code. Combine them for bold italic if needed.
Lists
Bullet lists:
- First item
- Second item
- Nested item
- Another nested item
Numbered lists:
- Step one
- Step two
- Step three
Links
Standard Markdown links work as expected: Meldoc website
For linking between documents, Meldoc has a special feature called magic links — see Magic Links.
Code blocks
Use fenced code blocks with a language tag for syntax highlighting:
function greet(name) {
return `Hello, ${name}!`;
}
# Push your docs to the server
meldoc push
Blockquotes
Blockquotes are great for tips, notes, or calling attention to important information.
Tables
| Feature | Syntax | Example |
|---|---|---|
| Bold | **text** |
text |
| Italic | *text* |
text |
| Code | `code` |
code |
| Link | [label](url) |
label |
Diagrams
Meldoc also supports Mermaid diagrams for flowcharts, sequence diagrams, and more. See Mermaid Diagrams for examples.