3
3
4
4
Welcome! This repository is a ** template** for launching your own Research Coding Community Coding Club website using ** Jupyter Book** . It includes:
5
5
6
- - 📚 A ready-to-edit site structure (home, community pages, courses )
6
+ - 📚 A ready-to-edit site structure (home, community pages, resources )
7
7
- ✅ Working ** GitHub Actions** for CI/CD to ** deploy to GitHub Pages**
8
8
- 🧩 ** Interactive quizzes** via ` jupyterquiz ` with sample content
9
9
- 🧪 Optional ** accessibility checks** workflow (Pa11y)
@@ -28,8 +28,8 @@ Welcome! This repository is a **template** for launching your own Research Codin
28
28
4 . ** Add or edit content**
29
29
- Update ` home_page.md ` .
30
30
- Edit community pages in ` community/ ` .
31
- - Add/modify courses in ` courses /` , update ` _toc.yml ` accordingly.
32
- - Try the quiz in ` courses/example_course /example_lesson.ipynb` .
31
+ - Add/modify resources in ` resources /` , update ` _toc.yml ` accordingly.
32
+ - Try the quiz in ` resources/example_resource /example_lesson.ipynb` .
33
33
34
34
5 . ** Push to ` main ` **
35
35
- GitHub Actions will build and deploy your site automatically.
@@ -45,9 +45,9 @@ Welcome! This repository is a **template** for launching your own Research Codin
45
45
├─ _toc.yml # Table of contents (navigation)
46
46
├─ home_page.md # Landing page
47
47
├─ community/ # Community pages (About, Code of Conduct, Join)
48
- ├─ courses /
49
- │ └─ example_course /
50
- │ ├─ README.md # Course overview
48
+ ├─ resources /
49
+ │ └─ example_resources /
50
+ │ ├─ README.md # Resource overview
51
51
│ └─ example_lesson.ipynb # Example notebook with quiz
52
52
├─ quizzes/
53
53
│ └─ sample_quiz.json # Example quiz
@@ -68,7 +68,7 @@ Welcome! This repository is a **template** for launching your own Research Codin
68
68
69
69
- ** Branding:** Replace ` _static/logo.png ` and set the ` logo: ` path in ` _config.yml ` .
70
70
- ** Theme:** Jupyter Book uses Sphinx Book Theme. You can add custom CSS in ` _static/ ` and reference it in ` _config.yml ` .
71
- - ** Content:** Add new courses in ` courses/your_course /` and include them in ` _toc.yml ` .
71
+ - ** Content:** Add new resources in ` resources/your_resource /` and include them in ` _toc.yml ` .
72
72
73
73
---
74
74
0 commit comments