Skip to content

mkdocs-shadcn

An MkDocs theme that brings the shadcn/ui style to documentation sites, installed from PyPI.

asiffer.github.io/mkdocs-shadcn

mkdocs-shadcn website screenshot
Added
GitHub stars
218
License
MIT
Price
Free

About

About mkdocs-shadcn

mkdocs-shadcn is an unofficial port of the shadcn/ui style to MkDocs, written by asiffer. It aims to carry the look over without becoming a heavy framework. It supports built-in Markdown extensions such as admonition, codehilite, footnotes and fenced code, plus several pymdownx ones. Its own extensions add ECharts, Iconify and executable code blocks, and its plugins cover Excalidraw, autonumbering and mkdocstrings in alpha.

Install it with pip install mkdocs-shadcn, then set theme name to shadcn in mkdocs.yml. The project's own documentation is built with the theme. The README advises against moving away from mkdocs-material if you depend on many of its extensions. The code is MIT licensed, with 218 stars.

mkdocs-shadcn features

6 features

  • shadcn/ui style for MkDocs
  • Admonitions, tabs and footnotes
  • ECharts and Iconify extensions
  • Executable code blocks
  • Excalidraw and autonumber plugins
  • Installable from PyPI

Install mkdocs-shadcn

1 command

Terminal

$ pip install mkdocs-shadcn

What you can build with mkdocs-shadcn

3 use cases

  • Restyling a Python project's docs in the shadcn/ui look
  • Embedding charts in MkDocs pages
  • Starting a new docs site with a clean theme

1 link

Pricing

Ship it with Pro

The directory is free. Pro adds 6,000+ blocks, 14 premium templates and the MCP server, so your AI editor installs them for you.

4.9/5 out of 5 · 150+ reviewsfrom 150+ founders and developers.

  • Secure checkout via Stripe
  • Code lives in your repo
  • Keep what you've shipped if you cancel
  • License terms

FAQ

Frequently asked questions

What mkdocs-shadcn is, how to install it, its license and its alternatives.

4.9 out of 5 from 150+ developers

Found your stack? Ship it.

6,000+ blocks, premium templates and MCP in every Pro plan. The directory stays free.

Get Pro