skip to content

Search

Syspirit
EN

Markdown

Markdown syntax for documentation and writing!

Languages
Published on

Markdown is a lightweight markup language that allows you to format text with a simple and readable syntax.

✏️ Text Formatting

📌 Action🧠 Syntax
✨ Bold text**text** or __text__
🎭 Italic text*text* or _text_
💪 Bold and italic***text***
Strikethrough~~text~~
Inline code`code`
Text^superscript^text^superscript^
Textsubscripttext~subscript~

📋 Headings and Structure

📌 Action🧠 Syntax
📝 Heading level 1# Main title
📄 Heading level 2## Section
📑 Heading level 3### Subsection
📋 Heading level 4#### Detail
📌 Heading level 5##### Precision
📍 Heading level 6###### Note
➖ Horizontal rule--- or ***

📝 Lists

📌 Action🧠 Syntax
• Bullet list- item or * item
1. Numbered list1. item
☐ Task list- [ ] task to do
☑ Completed task- [x] done task
📋 Nested list - sub-item (2 spaces)
📌 Action🧠 Syntax
🌐 Simple link[text](URL)
🏷️ Link with title[text](URL "title")
📧 Auto email<email@example.com>
🖼️ Simple image![alt](URL)
🖼️ Image with title![alt](URL "title")
🔗 Clickable image[![alt](img)](link)
⚓ Internal anchor[text](#anchor)

📊 Tables

📌 Action🧠 Syntax
📋 Basic table| Col1 | Col2 |
➖ Required separator|------|------|
⬅️ Left align|:-----|
↔️ Center align|:----:|
➡️ Right align|-----:|

💻 Code

📌 Action🧠 Syntax
⌨️ Inline code`code`
📄 Code blockcode
🎨 Code with language```bash
📝 Indented code4 spaces or 1 tab

💬 Quotes and Notes

📌 Action🧠 Syntax
📢 Simple quote> text
📜 Multi-line quote> line1
> line2
🔄 Nested quote> > text

📝 Notes Syntax (Admonitions)

Admonitions allow you to create colored callout boxes

Available Types

:::note
General information note
:::
 
:::tip
Useful tip or advice
:::
 
:::warning
Important warning
:::
 
:::caution
Attention, potential danger
:::
 
:::important
Crucial information
:::

With Custom Title

:::warning[Check Permissions]
Verify your rights before continuing
:::

🛠️ Common Troubleshooting

🆘 Problem🧠 Solution
🔗 Broken linkCheck [text](URL)
🖼️ Image not displayedCheck ![alt](path)
📊 Malformed tableCheck pipes `
💻 Code not highlightedSpecify the language
📝 Heading ignoredAdd space after #
🔤 Formatting not appliedCheck escaping \