Skip to content

Update readme.md and changelog.md #22

Update readme.md and changelog.md

Update readme.md and changelog.md #22

Workflow file for this run

name: Docs
on:
push:
branches:
- main
- dev
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: docs
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-24.04
defaults:
run:
working-directory: docs
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material mkdocs-github-admonitions-plugin mkdocs-minify-plugin mkdocs-redirects
pip install https://github.com/kfrlib/cxxdox/releases/download/v0.2.1/mkdocs_cxxdox-0.2.1-py3-none-manylinux_2_17_x86_64.whl
- name: Inject main.html
env:
MKDOCS_MAIN: ${{ secrets.MKDOCS_MAIN }}
run: |
echo "$MKDOCS_MAIN" >> custom/main.html
- name: Build site
run: |
mkdocs build --clean
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/site
deploy:
needs: build
runs-on: ubuntu-24.04
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4