Skip to content

Merge branch 'main' of https://github.com/codebase-interface/docs #6

Merge branch 'main' of https://github.com/codebase-interface/docs

Merge branch 'main' of https://github.com/codebase-interface/docs #6

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin pymdown-extensions mkdocs-mermaid2-plugin
- name: Configure git for deployment
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
- name: Build and deploy to gh-pages branch
run: mkdocs gh-deploy --force --clean
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}