markdown_features.md

mdts provides a rich Markdown reading experience by supporting the full CommonMark specification along with many popular extensions like GitHub Flavored Markdown (GFM) and additional enhancements for modern documentation.

✅ CommonMark Features

All standard Markdown syntax is fully supported:

• Headings: # H1 through ###### H6
• Paragraphs: Regular text blocks
• Emphasis:
  • Bold: **text** or __text__
  • Italic: *text* or _text_
• Blockquotes: Using >
• Lists:
  • Ordered: 1. Item
  • Unordered: - Item or * Item
• Code:
  • Inline: `code`
  • Block: ```lang
• Links: [label](https://example.com)
• Images: ![alt text](image.png)
• Horizontal Rules: ---, ***, or ___

🚀 Extended Features

📊 Tables

Render structured data in table format.

| Name     | Age | City      |
|----------|:---:|----------:|
| Alice    |  30 | Tokyo     |
| Bob      |  25 | New York  |

☑️ Task Lists

Perfect for checklists and todos.

- [x] Write documentation
- [ ] Implement feature

💡 GitHub Flavored Markdown (GFM)

mdts supports most GFM extensions, including:

• Autolinks: Bare URLs like https://example.com become clickable links
• Strikethrough: ~~text~~ renders as text
• Tables & Task Lists: (as shown above)

We aim to maintain compatibility with widely adopted Markdown standards to ensure smooth reading, sharing, and collaboration across platforms.

🎨 Advanced Syntax Highlighting

Code blocks get professional syntax highlighting with customizable themes through the settings dialog.

```rust
fn main() {
    println!("Hello, mdts!");
}
```

Choose from popular themes like Atom One Dark, GitHub, VS Code, and many more to match your preferred coding environment.

🔗 Footnotes

Add footnotes for inline references.

Here is some text with a footnote[^1].

[^1]: This is the footnote text.

📄 Frontmatter

Add YAML metadata at the top of your Markdown files.

---
title: "Sample Doc"
author: "Jane Doe"
tags: ["mdts", "docs"]
---

🧱 Inline HTML

Directly embed raw HTML when needed.

This is <strong>bold</strong> using HTML.

🧠 Mermaid Diagrams

Visualize workflows and diagrams using Mermaid.js.

```mermaid
graph TD;
    A[Start] --> B[Process];
    B --> C{Decision};
    C -->|Yes| D[End];
    C -->|No| A;
```

🎯 PlantUML Diagrams

Create UML diagrams with PlantUML syntax for sequence diagrams, class diagrams, and more.

```plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
@enduml
```

```puml
@startuml
class Car {
  +String brand
  +start()
  +stop()
}
@enduml
```

Supports both plantuml and puml language identifiers. Diagrams are rendered using the official PlantUML server.

🧮 Math Formulas (KaTeX)

Render beautiful mathematical expressions using LaTeX syntax with KaTeX.

```math
L = \frac{1}{2} \rho v^2 S C_L
```

Inline math: $E = mc^2$

Both block-level and inline mathematical expressions are fully supported with professional rendering quality.

📢 GitHub-Style Alerts

Create admonitions like notes, tips, and warnings.

> [!NOTE]
> This is a note.

> [!WARNING]
> This is a warning.