This repository is a template to set up webpages for CodeRefinery workshops, and has coordination of roles.
- (here collect all essential links for planning)
To use it, follow these instructions:
- Click the green "Use this template" button.
- Select owner of the new repository and repository name. The name should be
2019-10-16-workshop
. For in-person workshops we use "year-month-date-place" (e.g.2019-10-16-stockholm
). - Click "Create repository from template".
- You will now be redirected to the new repository.
- On "Settings" enable "GitHub Pages" from
gh-pages
as "Source". - Add the link to the generated pages on top right of the repository page at "About" to make it easier to find.
- Link the workshop from https://coderefinery.org/workshops/upcoming/.
- Adapt
config.toml
:- adapt
base_url
(it should contain a trailing slash) - adapt
title
- adapt settings below
[extra]
- adapt
- Adapt schedule in
content/schedule.yaml
. Use times in UTC. The times and dates are automatically displayed in the local time zone of the browser.
This template is based on the Zola static site engine.
To install Zola, follow:
- https://www.getzola.org/documentation/getting-started/installation/
- https://snapcraft.io/zola can be used for system that are not supported by default
- But you can also download the binary directly from here
Check that Zola is installed with $ zola --version
.
$ zola serve --open
This will open in your default browser a rendered version of the template.