Skip to content

Update index.md

Update index.md #14

Workflow file for this run

name: Build & Deploy Documentation
on:
push:
branches:
- main
paths:
- docs/**
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Update pip
run: python -m pip install --upgrade pip
- name: Install MkDocs
run: pip install mkdocs
- name: Install dependencies
run: pip install -r docs/requirements.txt
- name: Build documentation
run: mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
# publish_branch: main
publish_dir: ./site/
github_token: ${{ secrets.GITHUB_TOKEN }}