https://github.com/asiffer/mkdocs-shadcn
Documentation that also shines
https://github.com/asiffer/mkdocs-shadcn
mkdocs mkdocs-theme shadcn shadcn-ui
Last synced: 11 months ago
JSON representation
Documentation that also shines
- Host: GitHub
- URL: https://github.com/asiffer/mkdocs-shadcn
- Owner: asiffer
- License: mit
- Created: 2025-02-02T15:16:24.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-22T20:44:42.000Z (12 months ago)
- Last Synced: 2025-03-30T07:01:42.773Z (11 months ago)
- Topics: mkdocs, mkdocs-theme, shadcn, shadcn-ui
- Language: CSS
- Homepage: https://asiffer.github.io/mkdocs-shadcn/
- Size: 676 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-shadcn-ui - Link - 07-07 | (Ports)
README
The sleek shadcn theme on top of MkDocs
> [!IMPORTANT]
> This is an unofficial port of shadcn/ui to MkDocs, and is not affiliated with [@shadcn](https://twitter.com/shadcn).
## Documentation
Yes, yes, the [documentation](https://asiffer.github.io/mkdocs-shadcn/) is built with this theme.
## Quick start
`mkdocs-shadcn` can be installed with `pip`
```shell
pip install mkdocs-shadcn
```
Add the following line to `mkdocs.yml`:
```yaml
theme:
name: shadcn
```
## Extensions
The theme tries to support the built-in extensions along with some `pymdownx` ones.
- [x] [`admonition`](https://python-markdown.github.io/extensions/admonition/)
- [x] [`codehilite`](https://python-markdown.github.io/extensions/code_hilite/)
- [x] [`fenced_code`](https://python-markdown.github.io/extensions/fenced_code_blocks/)
- [x] [`pymdownx.tabbed`](https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/)
- [x] [`pymdownx.blocks.details`](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/details/)
- [x] [`pymdownx.blocks.tab`](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/tab/)
- [x] [`pymdownx.progressbar`](https://facelessuser.github.io/pymdown-extensions/extensions/progressbar/)
- [x] [`pymdownx.arithmatex`](https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/)
- [ ] custom [`shadcn.echarts`](https://echarts.apache.org)