Hackweek Website Template

THIS IS A TEMPLATE REPOSITORY designed to streamline creating two linked websites for a UW eScience Hackweek:

An event landing page built on a Tech Conference Theme
A JupyterBook for event content (including tutorials)

We've found that every hackweek benefits from a single-page website to get people's attention and consolidate important logistical details such as the 'who','what','why','when' of an event. In addition, JupyterBook provides a convenient means to consolidate and present tutorials with dynamic content such as executable code and dynamic figures.

Examples

We've used this template for the following events:

ICESat-2 Hackweek 2022: https://icesat-2.hackweek.io
SnowEx Hackweek 2021: https://snowex-hackweek.github.io/website/intro.html

How to use this template

You can use this template for your own event!

Click the "Use this template" button at the top of the repo
Select the account where you'd like to use the template.
Be sure to select the checkbox to include all branches! Otherwise your book will not be rendered automatically. You can remove all branches except for main and gh-pages from your new repo.
In your new repo, go to Settings > Pages to find the link to your JupyterBook. We recommend adding this link to the home page.
There are a few files you'll need to edit to customize content for your event:

cookiecutter.yaml: customize your landing page content
book/_config.yml: customize your JupyterBook content
README.md: a basic description of your project
CITATION.cff: add a standard citation file with all the event organizers

Design

We've designed this template so that you should only have to edit a few files with intuitive syntax. When changes are pushed to GitHub, continuous integration takes care of converting these files into HTML and publishing the website.

How to contribute

We are always trying to improve upon this template for future events and welcome contributions. Have a look at our code of conduct and contributing guide.