Collegium Academicum Website

This repo contains the code and content of collegiumacademicum.de.

Commiting workflow

You want to edit the website? Great!

• The master branch is configured so that any changes in there will go live on the website (http://collegiumacademicum.de).
• The test branch is configured that any changes in there will go live on the test website (https://test.collegiumacademicum.de).
• Any other branch does not have a live building attached to it.

To avoid any accidental changes going live, it is not possible to edit the master branch.

The workflow is as follows:

1. Make your changes on the test branch
   • If you are working on another branch (good idea!), first merge that one into the test branch
2. Wait for the building and copying to finish. You can see the current state in the Actions tab. (Takes ~20min).
3. Check https://test.collegiumacademicum.de if your changes look correct
4. Create a Pull request (PR) to merge your new version into the master branch. If you worked on the test branch then you can do this here.
5. If you're confident that everything is fine you can merge that new Pull request. But if there are bigger changes you can tag other developers on the PR to review your changes.
6. When the PR is merged the script will re-build the site and update the live website.

Requirements

• Hugo: >=0.49
• YARN

Installation

The website is a static website built with the static site generator Hugo. As CSS framework we use Bulma.

You will need to have the Hugo binary installed. You may do this by:

Dist	install command
Ubuntu	sudo apt-get install hugo
Arch Linux	sudo pacman -S hugo
Fedora	sudo yum install hugo

And you need Yarn

git clone https://github.com/CollegiumAcademicum/collegiumacademicum.de
yarn install

Compiling

Command	Function
./build_prod.sh	Build for online deployment (into ./upload/) and upload using lftp, used by .github/workflows/deploy_master.yaml
./build_test.sh	Build for online deployment on test website (into ./upload/) and upload using lftp, used by .github/workflows/deploy_test.yaml

Audio files

The audio files for the CA Ausstellung are way to big to put them in the Git project. Also having them in the content folder makes hugo considerably slower just because theyre huge. Therefore they have to be put into the web space by hand. Into the /audio/ folder.

Shortcodes

You can use the following custom shortcodes in the content markdown files to get programmatic content blocks:

Shortcode	function
{{< img src="" alt="" attr="" />}}	Includes an image and adds the modal popup. Note the trailing slash!
{{< pdf src="" width="" height="" >}}	Embeds a PDF.
{{< audio ### >}}	Embeds a audio file.
{{< quotes source="" size="" >}}	Prints a grid of quotes. Source team or supporters. Data can be added/edited in data/quotes_team.toml and data/quotes_supporters.toml
{{< timeline >}}	Prints the timeline. Data can be added/edited in data/timeline.toml
{{< partners >}}	Prints the list of partners. Data can be added/edited in data/partners.toml

Various

Videos

Encode videos two times as recommended by Mozilla:

• One with MP4 and libx264 Video + AAC audio

ffmpeg -i input.mp4 -c:a aac -crf 20 -preset slow -vf scale=-1:1080 output.mp4

• One with WEBM and VP8 video + Opus audio

ffmpeg -i input.mp4 -c:v libvpx-vp9 -c:a libopus -vf scale=-1:1080 output.webm

Icons

Get from http://fontello.com/.

Icons needed: heart, euro, user, mail-alt, exclamation, wrench, phone, info, user-secret, github-circled, home, language, wheelchair, instagram, facebook, help, quote-left, globe