[!IMPORTANT]
This is an unofficial port of shadcn/ui to MkDocs, and is not affiliated with @shadcn.
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
[!NOTE]
MkDocs is stale. You can use ProperDocs as a drop-in replacement.
Extensions
The theme tries to support the built-in extensions along with some pymdownx ones.
-
admonition -
codehilite -
fenced_code -
footnotes -
pymdownx.tabbed -
pymdownx.blocks.caption -
pymdownx.blocks.details -
pymdownx.blocks.tab -
pymdownx.progressbar -
pymdownx.arithmatex - builtin
shadcn.echarts - builtin
shadcn.iconify - builtin
shadcn.codexec
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
autonumberplugin 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 .
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-shadcn 0.12.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_shadcn-0.12.1.tar.gz | 3.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_shadcn-0.12.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 5.3 MB
Release files / mkdocs_shadcn-0.12.1.tar.gz
| Download URL | mkdocs_shadcn-0.12.1.tar.gz |
|---|---|
| Size | 3.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0353b0a49d74e8250784b44d98b887fc196f84a7fbe3b80b96f238d56f434b44
|
|
BLAKE2b-256 checksum How to use checksums |
91c424b235a03538d820bfee91f351b0213260ef5e526eea4e3042266642fdb7
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 29, 2026.
Transparency logRelease files / mkdocs_shadcn-0.12.1-py3-none-any.whl
| Download URL | mkdocs_shadcn-0.12.1-py3-none-any.whl |
|---|---|
| Size | 1.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2b355a2366469693eb8dbbfa6106c47c91b43fcf8df6a178a8afcd557cddc731
|
|
BLAKE2b-256 checksum How to use checksums |
b9ac5f3ad92de57ca426d9348bea283a3b6c74c3513768ba8dcadf3297c6f03d
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 29, 2026.
Transparency log
