mkdocs

site_name: Tech Docs
docs_dir: .

# MkDocs uses the Python Markdown library to translate Markdown files into HTML
markdown_extensions:
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tasklist
  - pymdownx.details

theme:
  name: material # pip install mkdocs-material
  # navigation_depth: 0
  # titles_only: true

plugins:
  - same-dir # pip install mkdocs-same-dir
  # - offline
  # - search
  # - social
  # - tags

Github Pages

• Build and Deploy pipeline

name: Deploy to Github Pages
on:
  workflow_dispatch:
  schedule:
    - cron: "0 0 * * SUN"
concurrency:
  group: pages
  cancel-in-progress: false
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v3
      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: 3.x
      - name: Compile With Mkdocs
        run: |
          pip install mkdocs
          mkdocs get-deps | xargs pip install
          mkdocs build
      - name: Upload Artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: ./site
  deploy:
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      pages: write
      id-token: write
    steps:
      - name: Deploy To GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2