Skip to content

docs: minor fixes in README #2154

docs: minor fixes in README

docs: minor fixes in README #2154

Workflow file for this run

name: GitHub Pages
on:
push:
branches:
- main # Set a branch name to trigger deployment
pull_request:
jobs:
deploy:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.8'
- name: Install dependencies
run: |
python3 -m pip install mkdocs # install mkdocs
python3 -m pip install mkdocs-material # install material theme
- name: Build mkdocs
run: |
mkdocs build -f ./docs/mkdocs.en.yml -s
mkdocs build -f ./docs/mkdocs.zh.yml -s
cp -av ./docs/index.html ./docs/site
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/site