GoSquatch is a fast Github Action that converts markdown into a static HTML site. This is useful for personal blogs and project documentation to keep pages in standard markdown while hosting them through Github Pages (or other providers). GoSquatch uses native golang templating and gomarkdown/markdown to handle markdown parsing. It includes a live building server so you can easily preview your site locally before publishing it. See the performance documentation for details on execution speed.
Check out our documentation built with GoSquatch!
Run the following commands to install GoSquatch using apt:
curl -s --compressed "https://www.mitchmcaffee.com/GoSquatch/ppa/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/gosquatch.gpg > /dev/null
sudo curl -s --compressed -o /etc/apt/sources.list.d/gosquatch_list_file.list "https://www.mitchmcaffee.com/GoSquatch/ppa/gosquatch_list_file.list"
sudo apt update
sudo apt install gosquatchTo preview your site locally run:
gosquatch -live-server -src-dir=./Add GoSquatch to your workflow to build pages during CI:
- uses: actions/checkout@v2
- name: Build pages
uses: themcaffee/GoSquatch@1.0.28-betaThe action reads markdown from src and outputs static files to dist ready for hosting.
The scripts and documentation in this project are released under the MIT License.