Skip to content

Commit 63d61c6

Browse files
authored
Explain how to use Notebooks instead of Markdown in materials (#24)
1 parent 65cf49e commit 63d61c6

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Jupyter ephemera
2+
.ipynb_checkpoints
13

24
# pixi environments
35
.pixi

for-instructors/style-guide.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,20 @@ Diátaxis is a fantastic resource for writing documentation for various audience
3333
Goal: Provide in-depth understanding of a concept, often linking multiple concepts
3434
together or explaining a technical decision, architecture, or history.
3535

36+
## Repository structure
3637

37-
## Structure
38+
### Notebooks vs. Markdown
39+
40+
Notebooks and Markdown can be used interchangeably.
41+
This means the content for your module can be stored in `index.md` or `index.ipynb`.
42+
43+
Supporting Notebooks can be stored as neighbors to your index file, and your Notebooks
44+
can link to each other.
45+
When participants open the Notebooks in JupyterLab they can click the links to
46+
automatically open other Notebooks.
47+
48+
49+
## Content structure
3850

3951
All modules should have a consistent structure!
4052

myst.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ project:
1616
- pattern: "0*.md"
1717
- title: "Modules"
1818
children:
19-
- pattern: "modules/0*/index.md"
19+
- pattern: "modules/0*/index.{md,ipynb}"
2020
- title: "Reference"
2121
children:
2222
- pattern: "reference/*.md"

0 commit comments

Comments
 (0)