Registry / web-framework / mkdocs-shadcn

mkdocs-shadcn

library0.10.7pypypiunverified

A MkDocs theme that ports shadcn/ui components to documentation sites. Current version 0.10.5, requires Python >=3.8. Active development with regular releases.

web-framework devops

pip install mkdocs-shadcn

package ↗

INSTALL

IMPORT

SIG · MKDOCS-SHADCN

mkdocs-shadcn

web-frameworkpythonv0.10.7

Install

3.7s avg

Import

—

Disk

42MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.10.7 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 43.9MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.7s · import 0.000s · 45MB

42MB installed

● package 42MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ShadcnTheme

✓ from shadcn import ShadcnTheme

✗ from mkdocs_shadcn import ShadcnTheme

Import the theme; configuration is done via mkdocs.yml.

import os from mkdocs_shadcn import ShadcnTheme # Example: output theme config (no build here) print("Theme ready. Configure mkdocs.yml with theme: shadcn")

Debug

Known issues

gotchaThe theme does not support MkDocs plugins that modify page content post-render (e.g., some search plugins). Ensure compatibility.

fix

Disable conflicting plugins or test thoroughly.

affects: <0.11.0

deprecatedVersion 0.9.x used 'shadcn' as theme name; newer versions require 'mkdocs-shadcn' in mkdocs.yml.

fix

Set theme: mkdocs-shadcn in mkdocs.yml.

affects: >=0.10.0

gotchaThe theme expects a specific directory structure for custom assets (e.g., docs/assets). Using a flat structure may break CSS/JS loading.

fix

Organize docs/ with assets/ subdirectory.

affects: all

Upgrade

Version history

0.10.7latest on PyPI · released May 20, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

12 hits · last 30 days

node

Resources

packagehttps://pypi.org/project/mkdocs-shadcn/ ↗