Skip to content

flam-flam/flam-flam.github.io

Repository files navigation

flam-flam.github.io

Documentation site for the project.

Backend for https://flam-flam.github.io

Local dev

The documentation site uses Jekyll

Pre

Install Chruby and Jekyll https://jekyllrb.com/docs/installation/

Launch local dev server

Start a local dev server by running make serve

Deployment

The site is using custom (ish) workflow for deployments: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/

The build runs on every push, but deploy can only run on main.

Docs

Github Pages guide: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll

Jekyll docs: https://jekyllrb.com/docs/usage/

Editorial theme: https://github.com/andrewbanchich/editorial-jekyll-theme

Icon set: https://fontawesome.com/v4/icons/