Skip to content

Added mkdocs deployment to GitHub actions. (#39) #1

Added mkdocs deployment to GitHub actions. (#39)

Added mkdocs deployment to GitHub actions. (#39) #1

Workflow file for this run

name: Deploy MkDocs Site
on:
push:
branches:
- main # Set this to the branch you want to trigger the deployment
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup 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 pymdown-extensions mkdocs-click
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
deploy_branch: gh-pages # The branch the built site will be pushed to
publish_dir: ./site # The folder MkDocs generates the site to