✨ Modern MkDocs Template¶

Welcome to your new documentation site! This template is pre-configured with the best plugins and extensions for a professional experience.

🚀 Key Features¶

🌓 Dark Mode support is built-in and follows system preferences by default.
📱 Mobile Friendly design that looks great on any screen.
🔍 Instant Search with highlighting and suggestions.
📊 Mermaid Diagrams for flowcharts, sequences, and more.
🔡 Latex Math support via Arithmatex.

📝 Markdown Examples¶

💡 Admonitions¶

Pro Tip

Use admonitions to highlight important information. They come in various flavors like note, abstract, info, tip, success, question, warning, failure, danger, bug, and example.

📑 Content Tabs¶

PythonJavaScript

def welcome():
    print("Welcome to MkDocs Material!")

function welcome() {
    console.log("Welcome to MkDocs Material!");
}

📉 Diagrams¶

graph LR
  A[Plan] --> B[Write]
  B --> C[Deploy]
  C --> D{Happy?}
  D -- Yes --> A
  D -- No --> B

🔢 Math Equations¶

When $a \ne 0$, there are two solutions to $ax^2 + bx + c = 0$ and they are $$x = {-b \pm \sqrt{b^2-4ac} \over 2a}$$

✅ Task Lists¶

Create project
Configure extensions
Write documentation
Profit!

🎨 Icons & Emojis¶

Built for speed
Open source
Media friendly

🛠️ Getting Started¶

Install dependencies:
```
pip install -r requirements.txt
```
Run locally:
```
mkdocs serve
```
Build site:
```
mkdocs build
```