Created
February 28, 2022 17:21
-
-
Save do-me/899dd07b7e948935cf0b6f5a365f33e4 to your computer and use it in GitHub Desktop.
Compress and deploy mkdocs (material) wiki with github pages. Uses gzipper for brotli, zopfli and gzip compression. Builds on standard CI by @squidfunk (https://squidfunk.github.io/mkdocs-material/publishing-your-site/#github-pages) from
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Mkdocs routine for continuous deployment | |
# This file must be on main branch under .github/workflows/ci.yml | |
name: ci | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: 3.x | |
# all plugins go here | |
- run: pip install mkdocs-material | |
- run: pip install lightgallery | |
- run: pip install mkdocs-minify-plugin | |
- run: mkdocs gh-deploy --force | |
# Node setup | |
- uses: actions/setup-node@v2 | |
with: | |
node-version: '14' | |
# install gzipper with npm | |
- run: npm install | |
- run: npm i gzipper -g | |
# check out other branch (gh-pages) | |
- uses: actions/checkout@v2 | |
with: | |
ref: gh-pages | |
# compress all files in all directories | |
- run: gzipper compress --include htm,html,css,js,svg,xml,map,json,img,png,jpg,jpeg --zopfli --brotli --remove-larger . | |
# commit | |
- uses: stefanzweifel/git-auto-commit-action@v4 | |
with: | |
commit_message: Compress Files | |
branch: gh-pages | |
push_options: '--force' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment