Skip to content

Commit

Permalink
add gh actions workflow to build mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
mlluciano committed Apr 10, 2024
1 parent 897c2d9 commit 5963ba4
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
34 changes: 34 additions & 0 deletions .github/workflows/deploy-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Deploy MkDocs Site from Search Branch

on:
push:
branches:
- search # This sets it to trigger on changes to the 'search' branch

jobs:
build-and-deploy:
runs-on: ubuntu-22.04

steps:
- uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.10.12'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: Build the MkDocs site
run: mkdocs build --verbose
working-directory: mkdocs

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./mkdocs/site
publish_branch: gh-pages # This pushes the build to the 'gh-pages' branch
1 change: 0 additions & 1 deletion mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
site_name: Official Documentation
site_author: Manuel Luciano
site_description: iDigBio User Documentation
site_dir: ../docs
theme:
features:
- navigation.tabs
Expand Down

0 comments on commit 5963ba4

Please sign in to comment.