{"id":24044,"library":"mkdocs-shadcn","title":"mkdocs-shadcn","description":"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.","status":"active","version":"0.10.5","language":"python","source_language":"en","source_url":"https://github.com/kiwicom/mkdocs-shadcn","tags":["mkdocs","theme","shadcn","documentation"],"install":[{"cmd":"pip install mkdocs-shadcn","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"Official import path for the theme class","symbol":"ShadcnTheme","correct":"from mkdocs_shadcn import ShadcnTheme"}],"quickstart":{"code":"import os\nfrom mkdocs_shadcn import ShadcnTheme\n\n# Example: output theme config (no build here)\nprint(\"Theme ready. Configure mkdocs.yml with theme: shadcn\")","lang":"python","description":"Import the theme; configuration is done via mkdocs.yml."},"warnings":[{"fix":"Disable conflicting plugins or test thoroughly.","message":"The theme does not support MkDocs plugins that modify page content post-render (e.g., some search plugins). Ensure compatibility.","severity":"gotcha","affected_versions":"<0.11.0"},{"fix":"Set theme: mkdocs-shadcn in mkdocs.yml.","message":"Version 0.9.x used 'shadcn' as theme name; newer versions require 'mkdocs-shadcn' in mkdocs.yml.","severity":"deprecated","affected_versions":">=0.10.0"},{"fix":"Organize docs/ with assets/ subdirectory.","message":"The theme expects a specific directory structure for custom assets (e.g., docs/assets). Using a flat structure may break CSS/JS loading.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"pip install mkdocs-shadcn and use correct import: from mkdocs_shadcn import ShadcnTheme","cause":"Typo in import or package not installed.","error":"ModuleNotFoundError: No module named 'mkdocs_shadcn'"},{"fix":"Change theme: shadcn to theme: mkdocs-shadcn in mkdocs.yml","cause":"Using old theme name in mkdocs.yml.","error":"ValueError: Unsupported theme 'shadcn'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}