Skip to content

MkDocs CI/CD🔗

Secrets🔗

Same as Hugo: SSH_HOST, SSH_USER, SSH_PRIVATE_KEY.

Workflow🔗

name: Build & Deploy (MkDocs)
on:
  push:
    branches: [ main ]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: Install Deps
        run: |
          python -m pip install --upgrade pip
          pip install mkdocs-material mkdocs-mermaid2-plugin mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin mkdocs-glightbox
      - name: Build
        run: mkdocs build --strict
      - name: Deploy via Rsync
        uses: burnett01/rsync-deployments@6.0.0
        with:
          path: site/
          remote_path: /srv/www/endershollow-docs/
          remote_host: ${{ secrets.SSH_HOST }}
          remote_user: ${{ secrets.SSH_USER }}
          remote_key:  ${{ secrets.SSH_PRIVATE_KEY }}

extra:
  homepage: https://endershollow.com