Skip to content

alexhutko/HPS

This branch is 67 commits behind SeisSCOPED/HPS:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2e6d2d0 Β· May 4, 2023
Sep 12, 2022
Apr 21, 2023
Sep 12, 2022
May 4, 2023
Sep 12, 2022
Sep 12, 2022
Apr 25, 2023
Jan 4, 2023
Sep 12, 2022
Sep 12, 2022
Sep 12, 2022
Apr 19, 2023
Apr 19, 2023
Sep 12, 2022
Sep 12, 2022
Sep 12, 2022
Apr 19, 2023
Apr 21, 2023

Repository files navigation

Hackweek Website Template

All Contributors

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

  1. An event landing page built on a Tech Conference Theme
  2. 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:

How to use this template

You can use this template for your own event!

  1. Click the "Use this template" button at the top of the repo
  2. Select the account where you'd like to use the template.
  3. 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.
  4. In your new repo, go to Settings > Pages to find the link to your JupyterBook. We recommend adding this link to the home page.
  5. 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.

Contributors ✨

Thanks for this template goes to these wonderful people (emoji key):


Marine Denolle

πŸ“‹ πŸ’» πŸ€” πŸ–‹

Anthony Arendt

πŸ“‹ πŸ€” πŸ–‹

Landung "Don" Setiawan

πŸ“‹ πŸ€” πŸ–‹ πŸ’»

Jessica

πŸ’» πŸ€” πŸ–‹

Joachim Meyer

πŸ’» πŸ€” πŸ–‹

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Resources

License

Citation

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 55.2%
  • Jupyter Notebook 16.9%
  • JavaScript 9.6%
  • TeX 8.5%
  • Shell 4.7%
  • Python 4.2%
  • CSS 0.9%