mkdocs-shadcn 0.1.0__tar.gz

mkdocs_shadcn-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,94 @@
+on:
+  workflow_dispatch:
+  push:
+    # Pattern matched against refs/tags
+    tags:
+      - "*" # Push events to every tag not containing /
+
+name: Publish mkdocs-shadcn to PyPI
+
+jobs:
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Build a binary wheel and a source tarball
+        run: uv build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: mkdocs-shadcn
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mkdocs-shadcn # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: mkdocs-shadcn
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+      - publish
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write # IMPORTANT: mandatory for sigstore
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: mkdocs-shadcn
+          path: dist/
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          "$GITHUB_REF_NAME"
+          --repo "$GITHUB_REPOSITORY"
+          --notes ""
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          "$GITHUB_REF_NAME" dist/**
+          --repo "$GITHUB_REPOSITORY"

mkdocs_shadcn-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+dev
+yarn.lock
+node_modules
+dist
+.venv
+__pycache__

mkdocs_shadcn-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 asiffer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocs_shadcn-0.1.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: mkdocs-shadcn
+Version: 0.1.0
+Summary: Documentation that also shines
+Author-email: Alban Siffer <31479857+asiffer@users.noreply.github.com>
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: mkdocs>=1.6.1
+Description-Content-Type: text/markdown
+
+# mkdocs-shadcn
+
+shadcn theme for MkDocs
+
+
+> [!IMPORTANT]  
+> This is an unofficial port of shadcn/ui to MkDocs, and is not affiliated with [@shadcn](https://twitter.com/shadcn).
+

mkdocs_shadcn-0.1.0/README.md

@@ -0,0 +1,8 @@
+# mkdocs-shadcn
+
+shadcn theme for MkDocs
+
+
+> [!IMPORTANT]  
+> This is an unofficial port of shadcn/ui to MkDocs, and is not affiliated with [@shadcn](https://twitter.com/shadcn).
+

mkdocs_shadcn-0.1.0/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "mkdocs-shadcn"
+version = "0.1.0"
+description = "Documentation that also shines"
+authors = [
+    { name = "Alban Siffer", email = "31479857+asiffer@users.noreply.github.com" },
+]
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = ["mkdocs>=1.6.1"]
+
+[dependency-groups]
+dev = ["pygments>=2.19.1", "pymdown-extensions>=10.14.2"]
+
+[project.entry-points."mkdocs.themes"]
+shadcn = "shadcn"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["shadcn"]

mkdocs_shadcn-0.1.0/shadcn/components/icon.html

@@ -0,0 +1,9 @@
+{% if config.theme.icon %}
+{% if config.theme.icon.startswith("http") %}
+<img class="h-6 w-6" src="{{ config.theme.icon }}">
+{% else %}
+<iconify-icon icon="{{ config.theme.icon }}" noobserver></iconify-icon>
+{% endif %}
+{% else %}
+{% include "icons/shadcn.svg" %}
+{% endif %}

mkdocs_shadcn-0.1.0/shadcn/components/new.html

@@ -0,0 +1,2 @@
+<span
+    class="ml-2 rounded-md bg-[#adfa1d] px-1.5 py-0.5 text-xs leading-none text-[#000000] no-underline group-hover:no-underline">New</span>

mkdocs_shadcn-0.1.0/shadcn/components/sidebar_item.html

@@ -0,0 +1,7 @@
+<a href="{{ sidebar_item.url | url }}" {% if sidebar_item.active %}data-active {% endif %}
+    class="text-sm flex h-8 w-full items-center rounded-lg px-2 text-foreground underline-offset-2 font-normal hover:bg-accent hover:text-accent-foreground data-active:bg-accent data-active:font-medium data-active:text-accent-foreground">
+    {{ sidebar_item.title }}
+    {% if sidebar_item.meta.new %}
+    {% include "components/new.html" %}
+    {% endif %}
+</a>