mkdocs-shadcn

banner

screenshot

Documentation

Yes, yes, the documentation is built with this theme.

Quick start

mkdocs-shadcn can be installed with pip (you may also need Pygments for syntax highlighting).

pip install mkdocs-shadcn

Add the following line to mkdocs.yml:

theme:
  name: shadcn

Extensions

The theme tries to support the built-in extensions along with some pymdownx ones.

Plugins

builtin excalidraw - With this plugin, you can directly edit your excalidraw scene in dev mode (kind of WYSIWYG) while it is rendered as svg at build time
mkdocstrings - a MkDocs plugin for auto-generating API documentation from docstrings. (alpha)
taylor-made autonumber plugin to automatically number and reference some elements (figures, tables, equations...)
mike - A Python utility that makes it easy to deploy multiple versions of your MkDocs-powered docs to a Git branch.

Developers

This project is open to contributions. In general, we need to apply the shadcn/ui style to already existing plugins or extensions.

We recently release the css sources we use to style the theme. It mainly uses tailwindcss.

Setup

First clone the repo:

git clone https://github.com/asiffer/mkdocs-shadcn
cd mkdocs-shadcn

Then you can install python dependencies (uv required),

uv sync --all-extras

and pre-commits:

uv run pre-commit install

Finally, you can install tailwind with your favourite package manager (npm, yarn, bun, etc.):

bun install

Dev mode

We use the project pages to as a test project for this theme. You can run the local server in the pages/ subdirectory.

cd pages/
uv run mkdocs serve --watch-theme -w ..

In parallel, you are likely to run the tailwind watcher to compile the css sources. In the root folder:

bun dev

Testing

Tests are managed by pytest and are located in the tests/ folder.

Currently we test:

browser issue through playwright
mike integration

You can run them as follows.

uv run pytest -xvs .

Metadata

Release files for mkdocs-shadcn 0.12.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-shadcn 0.12.2
File	Size	Uploaded
mkdocs_shadcn-0.12.2.tar.gz	3.5 MB	Oct 11, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-shadcn 0.12.2
File	Interpreter	ABI	Platform	Reset
mkdocs_shadcn-0.12.2-py3-none-any.whl 1.8 MB Oct 11, 2026	Python 3	none	any	Details

Total release size: 5.3 MB

Release files / mkdocs_shadcn-0.12.2.tar.gz

Download URL	mkdocs_shadcn-0.12.2.tar.gz
Size	3.5 MB
Tags	Source
SHA-256 checksum How to use checksums	`d59dd719be1da00cfff386557f1b0f7a6efe65b9020d05825fb76a836c0903ac`
BLAKE2b-256 checksum How to use checksums	`817750b0f4d0c093f5cdd1fcc168d45fa0000df4452e58b4a221ce18b4a06835`
Upload date	Oct 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/asiffer/mkdocs-shadcn
Publishing commit: github.com/asiffer/mkdocs-shadcn/tree/874c0f61ede638f2aadeca85957eb3b6a7d2d424

Workflow

Publishing configuration: github.com/asiffer/mkdocs-shadcn/blob/874c0f61ede638f2aadeca85957eb3b6a7d2d424/.github/workflows/release.yaml
Publishing logs: github.com/asiffer/mkdocs-shadcn/actions/runs/38143998226/attempts/1

Artifact

Subject: mkdocs_shadcn-0.12.2.tar.gz
SHA-256 checksum: d59dd719be1da00cfff386557f1b0f7a6efe65b9020d05825fb76a836c0903ac Verifying attestations

Release files / mkdocs_shadcn-0.12.2-py3-none-any.whl

Download URL	mkdocs_shadcn-0.12.2-py3-none-any.whl
Size	1.8 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`c2a64cf628052257b4869efd33ffb7f510e6df84462878a69e7a798982a22949`
BLAKE2b-256 checksum How to use checksums	`e3a7f9c82b9863f43b1326b1efe610b7d0cb723731a92451eb98e50ca38fb866`
Upload date	Oct 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/asiffer/mkdocs-shadcn
Publishing commit: github.com/asiffer/mkdocs-shadcn/tree/874c0f61ede638f2aadeca85957eb3b6a7d2d424

Workflow

Publishing configuration: github.com/asiffer/mkdocs-shadcn/blob/874c0f61ede638f2aadeca85957eb3b6a7d2d424/.github/workflows/release.yaml
Publishing logs: github.com/asiffer/mkdocs-shadcn/actions/runs/38143998226/attempts/1

Artifact

Subject: mkdocs_shadcn-0.12.2-py3-none-any.whl
SHA-256 checksum: c2a64cf628052257b4869efd33ffb7f510e6df84462878a69e7a798982a22949 Verifying attestations