/jupyter-slides-template

Jupyter notebook that renders as html slides

Primary LanguageJupyter NotebookMIT LicenseMIT

ssciwr.github.io/jupyter-slides-template

A simple way to convert a Jupyter notebook RISE presentation into an online web presentation.

The notebook jupyter-slides-template.ipynb is converted into reveal.js html slides and hosted by github pages at ssciwr.github.io/jupyter-slides-template

Quickstart

  • click the Use this template button to create your own repo based on this one
  • enable gh-pages for your repo: Settings -> Pages -> Source branch: gh-pages
  • slides will appear at YOUR_USERNAME.github.io/YOUR_REPO_NAME

Optional extras

  • add any additional Python libraries your notebook needs to 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