Use vitepress rendering

Author: afritzler

.github/dependabot.yml

@@ -9,3 +9,7 @@ updates:
     directory: "/docs"
     schedule:
       interval: "weekly"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/publish-docs.yml

@@ -1,34 +1,67 @@
-name: Publish docs via GitHub Pages
+name: Deploy VitePress site to Pages
+
 on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
   push:
-    branches:
-      - main
+    branches: [main]
+  pull_request:
+    types: [ assigned, opened, synchronize, reopened ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
 
 jobs:
-  deploy:
-    name: Deploy docs
+  # Build job
+  build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout main
+      - name: Checkout
         uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
-      - uses: actions/cache@v4
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
+      #   with:
+      #     version: 9 # Not needed if you've set "packageManager" in package.json
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache 
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs-material mkdocs-multirepo-plugin
-      - name: Deploy docs 
-        run: mkdocs gh-deploy --force
-env:
-  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          path: docs/.vitepress/dist
+        if: github.event_name != 'pull_request' # Skip upload on PRs
+
+  # Deployment job
+  deploy:
+    if: github.event_name != 'pull_request' # Skip deployment on PRs
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,2 +1,7 @@
 .idea/
-.vscode/
+.vscode/
+node_modules/
+docs/.vitepress/cache/*
+docs/.vitepress/dist/*
+.vitepress/
+.cache

Makefile

@@ -5,13 +5,13 @@
 CONTAINER_TOOL ?= docker
 
 # Docker image name for the mkdocs based local development setup
-IMAGE=ironcore-dev/multi-repo-docs
+IMAGE=ironcore-dev/docs
 
-.PHONY: start-docs
-start-docs: ## Start the local mkdocs based development environment.
-	$(CONTAINER_TOOL) build -t ${IMAGE} -f docs/Dockerfile . --load
-	$(CONTAINER_TOOL) run -p 8000:8000 -v `pwd`/:/docs ${IMAGE}
+.PHONY: startdocs
+startdocs: ## Start the local mkdocs based development environment.
+	docker build -t $(IMAGE) -f docs/Dockerfile . --load
+	docker run --rm -p 5173:5173 -v `pwd`/:/app $(IMAGE)
 
-.PHONY: clean-docs
-clean-docs: ## Remove all local mkdocs Docker images (cleanup).
-	$(CONTAINER_TOOL) container prune --force --filter "label=project=ironcore_project_multi_repo_docs"
+.PHONY: cleandocs
+cleandocs: ## Remove all local mkdocs Docker images (cleanup).
+	docker container prune --force --filter "label=project=ironcore_docs"

REUSE.toml

@@ -12,7 +12,9 @@ path = [
     "Makefile",
     "mkdocs.yml",
     "REUSE.toml",
-    "hack/**"
+    "hack/**",
+    "package-lock.json",
+    "package.json",
 ]
 precedence = "aggregate"
 SPDX-FileCopyrightText = "2025 SAP SE or an SAP affiliate company and IronCore contributors"

docs/Dockerfile

@@ -1,15 +1,15 @@
-FROM squidfunk/mkdocs-material:latest
+FROM node:24-alpine
 
-LABEL project=ironcore_project_multi_repo_docs
+LABEL project=ironcore_docs
 
-WORKDIR /docs
+# Install bash (optional but useful)
+RUN apk add --no-cache bash
 
-COPY docs/requirements.txt requirements.txt
-RUN pip install --no-cache-dir -r requirements.txt \
-    && apk add --no-cache bash
+# Set working directory
+WORKDIR /app
 
-EXPOSE 8000
+# Expose dev port
+EXPOSE 5173
 
-# Start development server by default
-ENTRYPOINT ["mkdocs"]
-CMD ["serve", "--dev-addr=0.0.0.0:8000"]
+# Default command to start VitePress dev
+ENTRYPOINT ["./hack/start-docs.sh"]

docs/baremetal/architecture/overview.md renamed to docs/baremetal/architecture/index.md

@@ -0,0 +1 @@
+# Cluster API (CAPI) for IronCore Bare Metal

docs/baremetal/kubernetes/capi.md

@@ -0,0 +1 @@
+# Cloud Controller Manager (CCM) for IronCore Bare Metal

docs/baremetal/kubernetes/cloud-controller-manager.md

@@ -0,0 +1 @@
+# Gardener Integration with IronCore Bare Metal