Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build Status

CaG Web II

Static Hugo website, using theme CasualGaming/fifty.

Project Structure

  • content/: Web pages.
  • static/: Static files placed in the web root of the built site.
  • themes/: Contains the theme (after you've run update-submodules.sh).
  • layouts/: Overrides or extensions for themes.
  • extra/: Extra files, not used to build the site.
  • manage/: Development scripts.
  • config.toml: Config file for the site, contains front page content as well.

Scripts and Commands

  • manage/update-submodules.sh: Updates the submodules, including the theme. You will get weird build errors if you forget this!
  • manage/build.sh: Build the site.
  • manage/clean.sh: Remove all temporary files.
  • manage/run.sh: Starts the development server with hot reloading.
  • docker build -t cag-web-2 .: (Requires Docker) Build the site in a Docker container. (Remember to pull the submodules first!)
  • docker run --rm -p 8080:80 cag-web-2: (Requires Docker) Run the site in a Docker container (using nginx) and forward port 8080 to it.

Editing

Online

Simple content changes and such can be easily changed directly within GitHub. When the file is committed to master, the site is automatically rebuilt and redeployed. Make sure the automatic build succeeds (here) and that the site is working after the deployment has finished (here) (at most 5 minutes after committing to master).

Offline without Docker

Requires Hugo. Allows you to run the site locally while making changes.

  • Run manage/update-submodules.sh to clone/update the submodules.
  • Run manage/run.sh to start the development server with hot reloading.

Offline with Docker

Doesn't require Hugo, but does not provide hot reloading.

  • Run manage/update-submodules.sh to clone/update the submodules.
  • Run manage/docker-build.sh to build the Docker image.
  • Run manage/docker-run.sh to run the image (doesn't build it).

Tips