https://github.com/coderefinery/template-workshop-webpage
You can create workshop pages from this template.
https://github.com/coderefinery/template-workshop-webpage
Last synced: 5 months ago
JSON representation
You can create workshop pages from this template.
- Host: GitHub
- URL: https://github.com/coderefinery/template-workshop-webpage
- Owner: coderefinery
- License: cc-by-4.0
- Created: 2019-10-02T07:50:49.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2026-01-19T16:56:23.000Z (5 months ago)
- Last Synced: 2026-01-19T22:53:51.394Z (5 months ago)
- Language: HTML
- Homepage: https://coderefinery.github.io/template-workshop-webpage/
- Size: 3.86 MB
- Stars: 6
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CodeRefinery workshop webpage
This repository is a template to set up webpages for CodeRefinery
workshops.
## Quick reference
- (here collect all essential links for planning)
## How to generate your workshop repository
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 look like
`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 .
### How to customize this template after you have created the repository
- Adapt `config.toml`:
- adapt `base_url` (it should contain a trailing slash)
- adapt `title`
- adapt settings below `[extra]`
- 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.
- Check texts, e.g. communication page, that they represent the setup of the current workshop
### How this template works
This template is based on the [Zola](https://www.getzola.org/) 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](https://github.com/getzola/zola/releases)
Check that Zola is installed with `$ zola --version`.
### Local preview
```
$ zola serve --open
```
This repository includes a Git submodule as for CSS styling. Make sure to clone with `--recursive` to also
clone the submodule:
```
$ git clone --recursive ...
```
If you cloned without `--recursive`, you can initialize the submodule with:
```
$ git submodule init
```