Giter VIP home page Giter VIP logo

jupyterbook-template's Introduction

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):


Scott Henderson

๐Ÿ“‹ ๐Ÿ’ป ๐Ÿค” ๐Ÿ–‹

Anthony Arendt

๐Ÿ“‹ ๐Ÿค” ๐Ÿ–‹

Landung "Don" Setiawan

๐Ÿ“‹ ๐Ÿค” ๐Ÿ–‹ ๐Ÿ’ป

Jessica

๐Ÿ’ป ๐Ÿค” ๐Ÿ–‹

Joachim Meyer

๐Ÿ’ป ๐Ÿค” ๐Ÿ–‹

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

jupyterbook-template's People

Contributors

scottyhq avatar jomey avatar aaarendt avatar jessicas11 avatar allcontributors[bot] avatar lsetiawan avatar dependabot[bot] avatar weiji14 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.