a-gavin / a-gavin.github.io

Website

This website uses the following open source tools:

• Zola static website generator
• shallz's Zola Deploy GitHub Action
• Tailwind CSS framework
• Prettier code formatter
• npm NodeJS package manager
• nvm NodeJS version manager

Repository Contents

• content/
  • Website content written in Markdown
  • Directory structure corresponds to structure used on website
    • content/blog.md served at https://a-gavin.github.io/blog.html
    • content/blog/bitmagic.md served at https://a-gavin.github.io/blog/bitmagic.html
• static/
  • Website static content, including CSS and images.
• templates/
  • Templates used for website content
  • partials/ contains partial templates allowing for reuse in other templates
  • post.html is used for all blog posts

Development Setup

1. Install Zola (static website generator)
   • Zola install guide
2. Install npm (via nvm) TODO
3. Install required node packages

   npm install

4. Generate tailwind CSS from config

   # Zola looks for CSS and favicon in `./static/` by default
   npx tailwindcss -i ./static/app.css -o ./static/main.css --watch

5. Serve webpage locally

   # The `shalzz/zola-deploy-action` GitHub action generates
   # the required directory structure for hosting on GitHub Pages
   # by running on all pushes to main.
   zola serve