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

Update README.md

Update README.md #34

Workflow file for this run

name: Build and Deploy to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v1
with:
python-version: '3.10'
- name: Install mkdocs
run: pip install mkdocs==1.4.3
- name: Setup Pages
id: pages
uses: actions/configure-pages@v1
- name: Build site
run: mkdocs build # defaults to '/site'
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: 'site/'
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1