Skip to content

Build to include logo and icon #7

Build to include logo and icon

Build to include logo and icon #7

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- main # The branch you want to deploy from
paths: # Only deploy MkDocs when the contents of the docs folder change or when this workflow changes.
- 'docs/**'
- '.github/workflows/Deploy MkDocs.yml'
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x' # specify the Python version
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: Build and deploy
run: |
mkdocs build
mkdocs gh-deploy --force
- name: Copy Module MD to Repository README
shell: pwsh
run: Copy-Item ./docs/index.md ./README.md
# git-auto-commit-action only runs on Linux-based platforms.
- name: Commit Changes to Repo
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: 'Copy MkDocs index to README'
file_pattern: "README.md"