The contents are hosted by github pages at https://rse.shef.ac.uk/dl-demystified-course/.
- Node & npm - Package management (Must use Node 16LTS due to vuepress dependency)
- vuepress - Website
- reveal-md - Slides
- google colab - Notebooks (python code)
The site is now automatically built and deployed to github pages using github actions in .github/workflows/site-deploy.yml.
Do not change the contents of gh-pages branch as it hosts the automatically built site contents.
├── build # The site builds to this folder for github pages deployment
├── notebooks # Lab notebooks
│ ├── assets # Notebook-specific assets
│ └── python # Notebooks in python
│ └── R # Notebooks in R
├── site # Vuepress website content
│ └── .vuepress # Vuepress configs
└── slides # Location of revealjs lesson slides
├── assets # Slides specific assets
- Install node js
- Run
npm installto install all package dependencies
To run the website run:
npm run site
Does not work in conjuction with the slides!
Run the slides using:
npm run slides
To view slides in full screen press F
To add notes to slides, add Note: followed by any text you want available through speaker mode to the bottom of any slide. You can include markdown notation in notes.
E.g.
---
Slide content
Note:
Slide notes
- Slide note bullet 1
- Slide note bullet 2
---
To initiate speaker view and access slide notes, press S.
Website is built to the build directory for testing the complete site. Use http-server build to test the complete site.
npm run build
http-server build