#What is MkDocs Shadcn?

MkDocs Shadcn is a free, open-source MkDocs theme that ports the clean, modern aesthetic of shadcn/ui to static documentation sites. Developed by asiffer as an unofficial shadcn/ui adaptation, its primary goal is to provide a lightweight, customizable theme for MkDocs without turning it into a bloated framework, targeting developers documenting Python projects, APIs, or open-source repos. Built with MkDocs, Python-Markdown extensions (e.g., pymdownx for tabs, progress bars), and Tailwind CSS for styling, it supports features like NEW/Beta tags on sidebar items, customizable icons, and per-page CSS/JS. It includes options like show_title, show_stargazers, and topbar_sections for flexible navigation. While not affiliated with shadcn, it aims to support core MkDocs extensions and some pymdownx ones. For shadcn/ui fans documenting code, MkDocs Shadcn is a perfect fit, leveraging MkDocs' simplicity with shadcn's polished design for beautiful, responsive docs sites.

#Features ⚡️

• Shadcn-Style Theme: Clean sidebar with categories, tags (NEW, Alpha, Beta), and customizable icons.

• MkDocs UI Integration: Builds on MkDocs for static site generation with Tailwind styling.

• Extension Support: Compatible with built-in and pymdownx extensions like admonitions, tabs, progress bars.

• CLI Support: Install via pip install mkdocs-shadcn and configure in mkdocs.yml.

• Responsive Design: Tailwind CSS ensures docs adapt to all screen sizes.

• Type Safety: Python-based with Markdown extensions for robust documentation.

#Pros ✅

• Shadcn Aesthetic: Clean, modern design without MkDocs Material's complexity.

• Free and Open-Source: MIT license allows unrestricted use and modification.

• Extension Compatibility: Supports core MkDocs and pymdownx for rich docs.

• Community Support: 79 GitHub stars, 2.6K PyPI downloads, active contributions.

• Easy Integration: Simple mkdocs.yml config for quick setup.

#Cons ⚠️

• Unofficial Port: Not affiliated with shadcn/ui, potential for inconsistencies.

• Limited Maturity: Recommends against migrating from mkdocs-material for advanced features.

• Python Dependency: Limited to Python/MkDocs ecosystems.

• Learning Curve: Familiarity with MkDocs YAML and extensions needed.

#Included Components - Templates

MkDocs Shadcn provides a variety of documentation theme elements:

• Sidebar Navigation: Categorized sections with tags and ordering.

• Top Bar: Optional sections for additional nav (topbar_sections: true).

• Page Layouts: Customizable titles, summaries, and datetime displays.

• Admonitions: Styled warnings, notes, and tips via pymdownx.

• Tabs & Progress Bars: Interactive elements from extensions.

#Pricing 💸

MkDocs Shadcn operates on a Free model:

• Free Access: All features free under MIT license, via PyPI.

• No Pro Version: No premium tiers or paid features.

#Integrations 🧰

MkDocs Shadcn integrates with:

• MkDocs: Core static site generator.

• Tailwind CSS: Styling for shadcn-like themes.

• pymdownx Extensions: Admonitions, tabs, progress bars, arithmetic.

• mkdocstrings: Auto-API documentation from docstrings.