Skip to content

🧪 MkDocs Formatting Showcase🔗

Explore advanced formatting features supported by MkDocs Material and pymdown-extensions.

🔔 Admonitions🔗

Friendly Reminder

You can use note, warning, danger, success, and other callout types.

Did You Know?

Admonitions can also be collapsible!

!!! tip "Expandable Section"
    More details go here...

🔗 Anchored Headings🔗

Every heading includes a permalink 🔗 when toc.permalink is enabled in mkdocs.yml. Great for sharing deep links.

😄 Emojis🔗

Use shortcodes like :rocket:, :tada:, or :mag: to add emojis:

🚀 Rapid launch
🛠️ Configuration
🎉 Celebration

🧷 SuperFences & Syntax Highlighting🔗

def greet(name):
    print(f"Hello, {name}!")

mkdocs build --clean
mkdocs serve

🌱 Tabbed Content🔗

Run dir to list files.

Use ls -la for a detailed file listing.

Try Get-ChildItem

📈 Mermaid Diagrams🔗

graph TD;
  Start --> Setup;
  Setup -->|Success| Build;
  Setup -->|Fail| Fix;
  Build --> Deploy;

🎨 Custom Badges🔗

Use HTML or inline styling for badges:

Beta
Deprecated

🧭 Task Lists🔗

  • [x] Install mkdocs-material
  • [x] Enable extensions
  • [ ] Create showcase page
  • [ ] Deploy to production

📦 Details Block (Toggle Disclosure)🔗

Expand to view usage tips
  • Use mkdocs serve for live preview
  • Enable toc.permalink for anchor links
  • Add extra_javascript to render Mermaid charts

📚 References🔗