{"repo":"asiffer/mkdocs-shadcn","free":true,"listed":false,"github":"https://github.com/asiffer/mkdocs-shadcn","clone":"git clone https://github.com/asiffer/mkdocs-shadcn.git","description":"Documentation that also shines","language":"CSS","stars":204,"topics":["mkdocs","mkdocs-theme","shadcn","shadcn-ui"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"[!IMPORTANT] This is an unofficial port of shadcn/ui to MkDocs, and is not affiliated with @shadcn. Documentation Yes, yes, the documentation is built with this theme. Quick start mkdocs-shadcn can be installed with pip (you may also need Pygments for syntax highlighting). Add the following line to mkdocs.yml : [!NOTE] MkDocs is stale. You can use ProperDocs as a drop-in replacement. Extensions The theme tries to support the built-in extensions along with some pymdownx ones. - [x] admonition - [x] codehilite - [x] fenced code - [x] footnotes - [x] pymdownx.tabbed - [x] pymdownx.blocks.caption - [x] pymdownx.blocks.details - [x] pymdownx.blocks.tab - [x] pymdownx.progressbar - [x] pymdownx.arithmatex - [x] builtin shadcn.echarts - [x] builtin shadcn.iconify - [x] builtin shadcn.codexec Plugins - [x] builtin excalidraw - 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 - [x] mkdocstrings - a MkDocs plugin for auto-generating API documentation from docstrings. (alpha) - [x] taylor-made autonumber plugin to automatically number and reference some elements (figures, tables, equations...) - [x] mike - A Python utility that makes it easy to deploy multiple versions of your MkDocs-powered docs to a Git branch. Developers This project is open to contributions. In general, we need to apply the shadcn/ui style to already existing plugins or extensions. We recently release the css sources we use to style","default_branch":null,"files":null,"tree":[],"storefront":"/r/asiffer","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/asiffer/mkdocs-shadcn/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}