Install
Add the package to your project.
pip install mkdocs-shadcn
uv add mkdocs-shadcn
poetry add mkdocs-shadcn
If you want to use pymdown extensions, you can also install the pymdown-extensions package:
pip install pymdown-extensions
uv add pymdown-extensions
poetry add pymdown-extensions
Tip
Don't forget to install Pygments to activate syntax highlighting.
No-brainer
You can init your new python project using uv and embed mkdocs documentation as follows.
uv init myproject
cd myproject
uv add --dev mkdocs mkdocs-shadcn pymdown-extensions Pygments
uv run mkdocs new .
echo -e "theme:\n name: shadcn" >> mkdocs.yml
uv run mkdocs serve --livereload