[!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
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 only test that there is no browser issue through playwright.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_shadcn-0.12.0.tar.gz.
File metadata
- Download URL: mkdocs_shadcn-0.12.0.tar.gz
- Upload date:
- Size: 3.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84dd648033177638943fd9f73fbb0d2e77f045c4f398bf37d05e46f64982435e
|
|
| MD5 |
eda622f670c8fd941912ff5ebcb79574
|
|
| BLAKE2b-256 |
8721beca6d960822ca437c375ec14168a2b9dda833b8e1f1e03b1253cb8531f0
|
Provenance
The following attestation bundles were made for mkdocs_shadcn-0.12.0.tar.gz:
Publisher:
release.yaml on asiffer/mkdocs-shadcn
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_shadcn-0.12.0.tar.gz -
Subject digest:
84dd648033177638943fd9f73fbb0d2e77f045c4f398bf37d05e46f64982435e - Sigstore transparency entry: 2247541172
- Sigstore integration time:
-
Permalink:
asiffer/mkdocs-shadcn@f240eaebcfcc1da9033ba78406ac1066a3694a04 -
Branch / Tag:
refs/tags/v0.12.0 - Owner: https://github.com/asiffer
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@f240eaebcfcc1da9033ba78406ac1066a3694a04 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mkdocs_shadcn-0.12.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_shadcn-0.12.0-py3-none-any.whl
- Upload date:
- Size: 1.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3d0e772d0bbc17f75c4882d6bfcc67544f3a52f5fd88acfe6233689fab7537a4
|
|
| MD5 |
bcb0ca1900db6530df7329448afdebe0
|
|
| BLAKE2b-256 |
9e6281fb02fb9072ec60fcc4e698677ca3d4eae7e95c991a0946aad526bb8e87
|
Provenance
The following attestation bundles were made for mkdocs_shadcn-0.12.0-py3-none-any.whl:
Publisher:
release.yaml on asiffer/mkdocs-shadcn
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_shadcn-0.12.0-py3-none-any.whl -
Subject digest:
3d0e772d0bbc17f75c4882d6bfcc67544f3a52f5fd88acfe6233689fab7537a4 - Sigstore transparency entry: 2247541460
- Sigstore integration time:
-
Permalink:
asiffer/mkdocs-shadcn@f240eaebcfcc1da9033ba78406ac1066a3694a04 -
Branch / Tag:
refs/tags/v0.12.0 - Owner: https://github.com/asiffer
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@f240eaebcfcc1da9033ba78406ac1066a3694a04 -
Trigger Event:
push
-
Statement type:
