Skip to content
This repository has been archived by the owner on Nov 12, 2024. It is now read-only.

Update readme.md

Update readme.md #49

Workflow file for this run

name: Deploy MkDocs
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material[imaging] mkdocstrings[python]
- name: Build site
run: mkdocs build --config-file ./mkdocs.yml
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site