Markdown • Syspirit

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^`
Text~~subscript~~	`text~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 list	`1. item`
☐ Task list	`- [ ] task to do`
☑ Completed task	`- [x] done task`
📋 Nested list	`- sub-item` (2 spaces)

🔗 Links and Images

📌 Action	🧠 Syntax
🌐 Simple link	`[text](URL)`
🏷️ Link with title	`[text](URL "title")`
📧 Auto email	`<[email protected]>`
🖼️ 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 block	`code`
🎨 Code with language	```bash
📝 Indented code	4 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 link	Check `[text](URL)`
🖼️ Image not displayed	Check `![alt](path)`
📊 Malformed table	Check pipes `
💻 Code not highlighted	Specify the language
📝 Heading ignored	Add space after `#`
🔤 Formatting not applied	Check escaping `\`

Search

➤Markdown

➤Markdown

✏️ Text Formatting

📋 Headings and Structure

📝 Lists

🔗 Links and Images

📊 Tables

💻 Code

💬 Quotes and Notes

📝 Notes Syntax (Admonitions)

Available Types

With Custom Title

🛠️ Common Troubleshooting

Table of Contents