https://github.com/ssciwr/jupyter-slides-template

Jupyter notebook that renders as html slides
https://github.com/ssciwr/jupyter-slides-template

hacktoberfest iwr-hacktoberfest

Last synced: 6 months ago
JSON representation

Jupyter notebook that renders as html slides

• Host: GitHub
• URL: https://github.com/ssciwr/jupyter-slides-template
• Owner: ssciwr
• License: mit
• Created: 2021-09-14T08:01:33.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-07T08:01:20.000Z (9 months ago)
• Last Synced: 2025-04-01T13:43:21.570Z (6 months ago)
• Topics: hacktoberfest, iwr-hacktoberfest
• Language: Jupyter Notebook
• Homepage:
• Size: 89.8 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# [ssciwr.github.io/jupyter-slides-template](https://ssciwr.github.io/jupyter-slides-template)

A simple way to convert a Jupyter notebook [RISE](https://rise.readthedocs.io/en/stable/) presentation into an online web presentation.

The notebook [jupyter-slides-template.ipynb](jupyter-slides-template.ipynb) is converted into [reveal.js](https://revealjs.com/) html slides and hosted by github pages at [ssciwr.github.io/jupyter-slides-template](https://ssciwr.github.io/jupyter-slides-template)

## Quickstart

- click the [Use this template](https://github.com/ssciwr/jupyter-slides-template/generate) button to create your own repo based on this one

- enable gh-pages for your repo: Settings -> Pages -> Source: `GitHub Actions`

- slides will appear at `YOUR_USERNAME.github.io/YOUR_REPO_NAME`

## Optional extras

- add any additional Python libraries your notebook needs to [requirements.txt](requirements.txt)

- go to https://pre-commit.ci/ to enable automatic code formatting for your repo

- install pre-commit to also do this on your computer

  - `pip install pre-commit`

  - `pre-commit install`