{"id":24975267,"url":"https://github.com/asiffer/mkdocs-shadcn","last_synced_at":"2026-04-12T15:29:58.584Z","repository":{"id":275447469,"uuid":"926106908","full_name":"asiffer/mkdocs-shadcn","owner":"asiffer","description":"Documentation that also shines ","archived":false,"fork":false,"pushed_at":"2025-03-22T20:44:42.000Z","size":692,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T07:01:42.773Z","etag":null,"topics":["mkdocs","mkdocs-theme","shadcn","shadcn-ui"],"latest_commit_sha":null,"homepage":"https://asiffer.github.io/mkdocs-shadcn/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asiffer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-02T15:16:24.000Z","updated_at":"2025-03-22T20:44:45.000Z","dependencies_parsed_at":"2025-03-11T17:22:25.229Z","dependency_job_id":"443c59bd-c9b7-46fa-8c12-4ba86dd85638","html_url":"https://github.com/asiffer/mkdocs-shadcn","commit_stats":null,"previous_names":["asiffer/mkdocs-shadcn"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiffer%2Fmkdocs-shadcn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiffer%2Fmkdocs-shadcn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiffer%2Fmkdocs-shadcn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiffer%2Fmkdocs-shadcn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asiffer","download_url":"https://codeload.github.com/asiffer/mkdocs-shadcn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249678881,"owners_count":21309839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-theme","shadcn","shadcn-ui"],"created_at":"2025-02-03T20:55:19.023Z","updated_at":"2026-04-12T15:29:58.572Z","avatar_url":"https://github.com/asiffer.png","language":"CSS","funding_links":[],"categories":["Ports"],"sub_categories":[],"readme":"\n![banner](./.github/assets/banner.png)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/squidfunk/mkdocs-shadcn/actions\"\u003e\u003cimg\n    src=\"https://github.com/asiffer/mkdocs-shadcn/actions/workflows/testing.yaml/badge.svg\"\n    alt=\"Testing\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://pypistats.org/packages/mkdocs-shadcn\"\u003e\u003cimg\n    src=\"https://img.shields.io/pypi/dm/mkdocs-shadcn.svg\"\n    alt=\"Downloads\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/mkdocs-shadcn\"\u003e\u003cimg\n    src=\"https://img.shields.io/pypi/v/mkdocs-shadcn.svg\"\n    alt=\"Python Package Index\"\n  /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n![screenshot](./.github/assets/screenshot.png)\n\n\n\u003e [!IMPORTANT]  \n\u003e This is an unofficial port of shadcn/ui to MkDocs, and is not affiliated with [@shadcn](https://twitter.com/shadcn).\n\n\n## Documentation\n\nYes, yes, the [documentation](https://asiffer.github.io/mkdocs-shadcn/) is built with this theme.\n\n## Quick start\n\n`mkdocs-shadcn` can be installed with `pip`\n\n```shell\npip install mkdocs-shadcn\n```\n\nAdd the following line to `mkdocs.yml`:\n\n```yaml\ntheme:\n  name: shadcn\n```\n\n## Extensions\n\nThe theme tries to support the built-in extensions along with some `pymdownx` ones. \n\n- [x] [`admonition`](https://python-markdown.github.io/extensions/admonition/)\n- [x] [`codehilite`](https://python-markdown.github.io/extensions/code_hilite/)\n- [x] [`fenced_code`](https://python-markdown.github.io/extensions/fenced_code_blocks/)\n- [x] [`footnotes`](https://python-markdown.github.io/extensions/footnotes/)\n- [x] [`pymdownx.tabbed`](https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/)\n- [x] [`pymdownx.blocks.details`](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/details/) \n- [x] [`pymdownx.blocks.tab`](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/tab/) \n- [x] [`pymdownx.progressbar`](https://facelessuser.github.io/pymdown-extensions/extensions/progressbar/)\n- [x] [`pymdownx.arithmatex`](https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/)\n- [x] builtin [`shadcn.echarts`](https://asiffer.github.io/mkdocs-shadcn/extensions/echarts/)\n- [x] builtin [`shadcn.iconify`](https://asiffer.github.io/mkdocs-shadcn/extensions/iconify/)\n- [x] builtin [`shadcn.codexec`](https://asiffer.github.io/mkdocs-shadcn/extensions/codexec/) \n\n\n## Plugins\n\n- [x] builtin [`excalidraw`](https://excalidraw.com/) - 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.\n- [x] [`mkdocstrings`](https://mkdocstrings.github.io/) - a MkDocs plugin for auto-generating API documentation from docstrings. (alpha)\n\n## Developers\n\nThis project is open to contributions. In general, we need to apply the shadcn/ui style to already existing plugins or extensions. \n\nWe recently release the css sources we use to style the theme. It mainly uses [`tailwindcss`](https://tailwindcss.com/).\n\n### Setup\n\nFirst clone the repo:\n```shell\ngit clone https://github.com/asiffer/mkdocs-shadcn\ncd mkdocs-shadcn\n```\n\nThen you can install python dependencies ([`uv`](https://docs.astral.sh/uv/) required):\n```shell\nuv sync --all-extras\n```\n\nFinally, you can install tailwind with your favourite package manager (npm, yarn, bun, etc.):\n\n```shell\nbun install\n```\n\n### Dev mode\n\nWe use the project pages to as a test project for this theme. You can run the local server in the `pages/` subdirectory.\n\n```shell\ncd pages/\nuv run mkdocs serve --watch-theme -w ..\n```\n\nIn parallel, you are likely to run the tailwind watcher to compile the css sources. In the root folder:\n\n```shell\nbun dev\n```\n\n### Testing\n\nTests are managed by [`pytest`](https://docs.pytest.org/en/stable/) and are located in the [tests/](./tests/) folder.\n\nCurrently we only test that there is no browser issue through [playwright](https://playwright.dev/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasiffer%2Fmkdocs-shadcn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasiffer%2Fmkdocs-shadcn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasiffer%2Fmkdocs-shadcn/lists"}