From 43699b9bbd762685b37da635963a1a85c5af6f8c Mon Sep 17 00:00:00 2001 From: snothub Date: Sat, 4 Apr 2026 17:46:08 +0200 Subject: [PATCH] MkDocs --- .github/workflows/docs.yml | 24 ++++++++++++++++----- .project-standards.yaml | 3 ++- mkdocs.yml | 43 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+), 6 deletions(-) create mode 100644 mkdocs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 23f98f4..ebfb00a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,6 +5,7 @@ on: branches: [main] paths: - 'docs/**' + - 'mkdocs.yml' workflow_dispatch: permissions: @@ -17,19 +18,32 @@ concurrency: cancel-in-progress: false jobs: - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} + build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Install dependencies + run: pip install mkdocs mkdocs-material + + - run: mkdocs build + - uses: actions/configure-pages@v5 - uses: actions/upload-pages-artifact@v3 with: - path: './docs' + path: './site' + deploy: + needs: build + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: - id: deployment uses: actions/deploy-pages@v4 diff --git a/.project-standards.yaml b/.project-standards.yaml index 371611a..d7c9612 100644 --- a/.project-standards.yaml +++ b/.project-standards.yaml @@ -2,5 +2,6 @@ standards_version: "2025.1" last_configured: "2026-04-04" components: github-pages: "2025.1" - github-pages-generator: "static" + github-pages-generator: "mkdocs" github-pages-source: "docs/" + github-pages-theme: "material" diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d7230c5 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,43 @@ +site_name: K8s Launchpad +site_description: Documentation for the GitOps-managed Kubernetes cluster +repo_url: https://github.com/fortedigital/sturdy-adventure +repo_name: fortedigital/sturdy-adventure + +theme: + name: material + palette: + - scheme: default + primary: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: indigo + toggle: + icon: material/brightness-4 + name: Switch to light mode + features: + - navigation.instant + - navigation.sections + - navigation.top + - search.highlight + - content.code.copy + +nav: + - Home: README.md + - GitOps Architecture: GITOPS-ARCHITECTURE.md + - Developer Guide: DEVELOPER-GUIDE.md + - Operations Runbook: OPERATIONS-RUNBOOK.md + - Technical Reference: REFERENCE.md + +markdown_extensions: + - tables + - toc: + permalink: true + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - admonition + - pymdownx.details