|
2 | 2 |
|
3 | 3 | ## Features
|
4 | 4 |
|
5 |
| -1. Support for executing code in a browser using [thebe](https://thebe.readthedocs.io/en/latest/) and [mybinderorg](https://mybinder.org)! |
| 5 | +1. Support for executing code in a browser using [thebe](https://thebe.readthedocs.io/en/latest/) and [mybinderorg](https://mybinder.org)! |
6 | 6 |
|
7 |
| -1. Structured book with markdown file stubs aligning with a course structure for a 13 week course. Fully versioned using GitHub, automatically deployed using GH Actions to either GH or your own server. Can also be extended with a testing framework for extra peace of mind. |
| 7 | +2. Structured book with markdown file stubs aligning with a course structure for a 13 week course. |
| 8 | + Fully versioned using GitHub, automatically deployed using GH Actions to either GH or your own server. |
| 9 | + Can also be extended with a testing framework for extra peace of mind. |
8 | 10 |
|
9 |
| -1. [Examples of how to use IFrames](https://firasm.github.io/jupyterbook_course_template/notes/topic1.html#) to embed web content, @phet_sims, @sli.do polls, videos, and other content. |
| 11 | +3. [Examples of how to use IFrames](https://firasm.github.io/jupyterbook_course_template/notes/topic1.html#) to embed web content, @phet_sims, @sli.do polls, videos, and other content. |
10 | 12 |
|
11 |
| -1. Powerful built-in annotation and commenting features with [hypothes.is](http://hypothes.is) and [utteranc.es](http://utteranc.es). Annotate your syllabus, course readings, and any other content. |
| 13 | +4. Powerful built-in annotation and commenting features with [hypothes.is](http://hypothes.is) and [utteranc.es](http://utteranc.es). |
| 14 | + Annotate your syllabus, course readings, and any other content. |
12 | 15 |
|
13 |
| -1. Add persistent checkboxes so students can track their progress through notebooks, exercises and readings. |
| 16 | +5. Add persistent checkboxes so students can track their progress through notebooks, exercises and readings. |
14 | 17 |
|
15 |
| -1. Allow students to download pages of the site in PDF, link to the source code on your repo, or open in a mybinder notebook. |
| 18 | +6. Allow students to download pages of the site in PDF, link to the source code on your repo, or open in a mybinder notebook. |
16 | 19 |
|
17 |
| -1. The JupyterBook can be embedded into Canvas using the Redirect tool so students never have to leave their LMS. |
| 20 | +7. The JupyterBook can be embedded into Canvas using the Redirect tool so students never have to leave their LMS. |
18 | 21 |
|
19 |
| -1. (NEW!) Use of the new `substitution` feature of [myst-parser](https://myst-parser.readthedocs.io/en/latest/develop/_changelog.html#id1) to configure the course algorithmically from the `_config.yml` file! |
| 22 | +8. (NEW!) Use of the new `substitution` feature of [myst-parser](https://myst-parser.readthedocs.io/en/latest/develop/_changelog.html#id1) to configure the course algorithmically from the `_config.yml` file! |
20 | 23 |
|
21 | 24 | ## Edit the template for your course
|
22 | 25 |
|
23 | 26 | There are a few things you need to do to adapt this template for your course.
|
24 | 27 | I might miss a few things, so this list is a work in progress:
|
25 | 28 |
|
26 |
| -1. In the `_config.yml` file: |
| 29 | +1. In the `_config.yml` file: |
27 | 30 |
|
28 |
| - - [ ] Set title of the book (Physics 111) |
29 |
| - - [ ] Update author (Firas Moosvi) |
30 |
| - - [ ] Update logo image (images/logo.png) |
31 |
| - - [ ] Add Google Analytics ID (Optional) |
32 |
| - - [ ] Enable/Disable Hypothes.is (remove the line to remove the hypothes.is integration) |
33 |
| - - [ ] Configure Utteranc.es repository (Choose one of Hypothesis or Utteranc.es) |
34 |
| - - [ ] Adjust `extra_footer` to control License of course materials |
35 |
| - - [ ] Set the substitution parameters under the `myst_substitutions` |
| 31 | + - [ ] Set title of the book (Physics 111) |
| 32 | + - [ ] Update author (Firas Moosvi) |
| 33 | + - [ ] Update logo image (images/logo.png) |
| 34 | + - [ ] Add Google Analytics ID (Optional) |
| 35 | + - [ ] Enable/Disable Hypothes.is (remove the line to remove the hypothes.is integration) |
| 36 | + - [ ] Configure Utteranc.es repository (Choose one of Hypothesis or Utteranc.es) |
| 37 | + - [ ] Adjust `extra_footer` to control License of course materials |
| 38 | + - [ ] Set the substitution parameters under the `myst_substitutions` |
36 | 39 |
|
37 |
| -1. In the `_toc.yml` file: |
38 |
| - - [ ] Arrange the table of contents to add/remove files |
39 |
| - |
40 |
| -1. In the `about` and `class` folders: |
41 |
| - - [ ] Edit the .md and .ipynb files with your course content |
| 40 | +2. In the `_toc.yml` file: |
| 41 | + |
| 42 | + - [ ] Arrange the table of contents to add/remove files |
| 43 | + |
| 44 | +3. In the `about` and `class` folders: |
| 45 | + |
| 46 | + - [ ] Edit the .md and .ipynb files with your course content |
| 47 | + |
| 48 | +Source code for the CPSC 203 course website of the Department of Computer Science at the University of British Columbia. |
| 49 | + |
| 50 | +## Website notes |
| 51 | + |
| 52 | +The course schedule is dynamically generated form the files the directories `pre-readings`, `slides`, `worksheets`, and `labs` using R. |
| 53 | +- Files belonging to one unit should be named after the following pattern: `<id>_<file-name>`. |
| 54 | +- `id` is a unique identifier to join tables for all related resources to produce the schedule table in `index.qmd`. |
| 55 | + |
| 56 | +## Setup |
| 57 | + |
| 58 | +We recommend developing content locally on your computer in a container accessed by [Visual Studio Code](https://code.visualstudio.com/). |
| 59 | +Follow the setup instructions outlined in [Developing inside a Container using Visual Studio Code Remote Development](https://code.visualstudio.com/docs/devcontainers/containers) including the installation of Docker and the VS Code extension [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). |
| 60 | +After cloning this repo locally to your computer, open the directory using the command **Dev Containers: Open Folder in Container…** from the Command Palette in VS Code. |
42 | 61 |
|
43 | 62 | ## Attribution
|
44 | 63 |
|
45 |
| -- Thanks the entire [Jupyter Project](https://jupyter.org/about) |
46 |
| -- Finally, a big thanks to the [JupyterBook community](https://github.com/executablebooks/jupyter-book/graphs/contributors) for my incessant issues, questions, and PR requests on documentation changes. |
| 64 | +This website design is based on: |
| 65 | + |
| 66 | +- [STA 199 by Mine Çetinkaya-Rundel](https://sta199-s24.github.io/) |
| 67 | +- [ESPM 157 by Carl Boettinger](https://espm-157.carlboettiger.info/) |
| 68 | +- [STA 112 by Lucy D'Agostino McGowan](https://sta-112-s24.github.io/website/) |
| 69 | +- [PMAP 8521 by Andrew Heiss](https://evalsp25.classes.andrewheiss.com/) |
| 70 | + |
| 71 | +Some material was adapted from: |
| 72 | + |
| 73 | +- [rstudio::conf-2022 Workshop on Quarto by Tom Mock et al.](https://github.com/rstudio-conf-2022/get-started-quarto) |
0 commit comments