Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
49f5146
Tweaks to mini-exercise
mfisher87 Nov 24, 2025
ef0c6bd
Add environment management dropdown
mfisher87 Nov 24, 2025
6d7b968
Reinforce normality of GH warning
mfisher87 Nov 24, 2025
044e245
Fix missing line emphasis
mfisher87 Nov 24, 2025
cca831b
First couple steps of building PDF, including Matt's usual YAML rant
mfisher87 Nov 24, 2025
601653a
Fix header level
mfisher87 Nov 24, 2025
4e15518
Qualify YAML dropdown as a rant
mfisher87 Nov 24, 2025
bd18f5a
Add title header to document
mfisher87 Nov 25, 2025
db581e1
Adjust language setting for consistency
mfisher87 Nov 25, 2025
558a792
Use Typst for PDF rendering
mfisher87 Nov 25, 2025
f9d7b72
Document building a PDF
mfisher87 Nov 25, 2025
1fc6bb6
Remove dangling ref
mfisher87 Nov 25, 2025
9a222f5
Add exercise D content
mfisher87 Nov 25, 2025
f93957a
Move TODOs to dropdown at the beginning
mfisher87 Nov 25, 2025
76dac5e
Add missing period
mfisher87 Nov 25, 2025
7f5c0db
Better "you should notice..." callout
mfisher87 Nov 25, 2025
4a52f62
Make "notice" callouts more consistent
mfisher87 Nov 25, 2025
b27fbb1
Module 5 exercise E (#50)
mfisher87 Nov 25, 2025
c68fec7
Remove redundant "notice..." callout
mfisher87 Nov 26, 2025
b616ce4
Add a "Joining late?" callout to clone the repo
mfisher87 Nov 26, 2025
3e28d84
Improve late-joiner instructions to setup GH auth
mfisher87 Nov 26, 2025
992f7b7
Fix typo
mfisher87 Nov 26, 2025
d47719a
Add more context to "the normal way" to build with MyST
mfisher87 Nov 26, 2025
c778ff3
Use test tube emoji to denote tests
mfisher87 Nov 26, 2025
142d64a
Fix typo, adjust whitespace
mfisher87 Nov 26, 2025
38ce8f2
Add checkpoints to commit and push using custom plugin
mfisher87 Nov 26, 2025
4631c55
Extract `{youShouldNotice}` directive
mfisher87 Nov 27, 2025
d363a15
Fix line emphasis
mfisher87 Nov 27, 2025
37cb6dd
Add documentation for new custom helpers
mfisher87 Nov 27, 2025
f50fdc7
Populate "What do we know" section for DOIs
mfisher87 Nov 27, 2025
7f24494
Remove unnecessary block wrappers
mfisher87 Nov 27, 2025
8ce6f46
Change body type of youShouldKnow directive to "myst", removing need …
mfisher87 Nov 27, 2025
a35a9dd
Create `{myst:static}` directive first draft
mfisher87 Nov 27, 2025
f424b4c
Remove unnecessary newlines
mfisher87 Nov 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions assets/styles/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,42 @@ body {
[aria-label="Document Outline"] {
max-height: calc(100vh - 100px) !important;
}

.myst-static-input-wrapper {
border: 1px solid #ccc;
}

.myst-static-input-wrapper::before {
content: "📥 MyST input";
display: block;
background-color: #f5f5f5;
border-bottom: 1px solid #ccc;
padding: 8px 12px;
font-weight: bold;
font-size: 14px;
color: #333;
margin: 0;
}

.myst-static-output-wrapper {
border: 1px solid #ccc;
margin-bottom: 20px;
}

.myst-static-output-wrapper::before {
content: "📤 MyST output";
display: block;
background-color: #f5f5f5;
border-bottom: 1px solid #ccc;
padding: 8px 12px;
font-weight: bold;
font-size: 14px;
color: #333;
margin: 0;
}

.myst-static-content {
padding-left: 12px;
padding-right: 12px;
margin: 0;
}
25 changes: 25 additions & 0 deletions for-instructors/helpers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 🪄 Helpers

This repository includes a `plugin-custom-directives.mjs` file which defines custom
directives that will save some time authoring certain repeated elements.

## Git commit checkpoint directive

```{myst:static}
:::{gitCommitCheckpoint} my commit message
:::
```


## "You should notice..." directive

``````{myst:static}
:::{youShouldNotice}
...the `{youShouldNotice}` directive fully supports markdown in the body.
This means you can, for example include some code:

```python
print("Some code!")
```
:::
``````
24 changes: 24 additions & 0 deletions for-instructors/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,30 @@ E.g.:
:::
```

**As a shortcut, you can use the `{youShouldNotice}` directive.**
See [](./helpers.md).


#### Committing

Use 💾 in a callout to indicate that the user should stop and do a commit now.
Provide the full set of commands the user should run.

``````{myst}
:::{important} 💾 Commit & push to GitHub
:icon: false

```bash
git add .
git commit -m "Commit message"
git push -u origin main
```
:::
``````

**As a shortcut, you can use the `{gitCommitCheckpoint}` directive.**
See [](./helpers.md).


### Voice / language

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading