Setup

Be ready to contribute

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

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

Tests are managed by pytest and are located in the tests/ folder.

Currently we test: - browser issue through playwright - mike integration

You can run them as follows.

uv run pytest -xvs .