Skip to main content

banner

Testing Downloads Python Package Index

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:

You can run them as follows.

uv run pytest -xvs .

Metadata

Release files for mkdocs-shadcn 0.13.0

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.13.0
File Size Uploaded Provenance Actions
mkdocs_shadcn-0.13.0.tar.gz 3.5 MB With provenance Details for mkdocs_shadcn-0.13.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-shadcn 0.13.0
File Interpreter ABI Platform Actions
mkdocs_shadcn-0.13.0-py3-none-any.whl Python 3 none any Details for mkdocs_shadcn-0.13.0-py3-none-any.whl

Total release size: 5.3 MB

Release files / mkdocs_shadcn-0.13.0.tar.gz

Download URL mkdocs_shadcn-0.13.0.tar.gz
Size 3.5 MB
Tags Source
SHA-256 checksum
How to use checksums
875c206a90d70a8f0ba2e2afe5b38495b896961aaaa03e98838f76e11a1f93f1
BLAKE2b-256 checksum
How to use checksums
d52f702cf0a53c34251998925ed6f895ea692615cac06ccef9c6857c31de0c4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 17, 2026.

Transparency log

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

Download URL mkdocs_shadcn-0.13.0-py3-none-any.whl
Size 1.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8455cd2ec37dc46093e786396f95498951a90af5800a98f3f867103509518a0f
BLAKE2b-256 checksum
How to use checksums
5080762a23b570745a2f840ce284db441498b1f9dd99354e185859666fd267a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 17, 2026.

Transparency log

Security for mkdocs-shadcn 0.13.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for mkdocs_shadcn-0.13.0.tar.gz

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 Nov 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.13.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page