File tree Expand file tree Collapse file tree 2 files changed +61
-0
lines changed Expand file tree Collapse file tree 2 files changed +61
-0
lines changed Original file line number Diff line number Diff line change 1+ # 🪄 Helpers
2+
3+ This repository includes a ` plugin-custom-directives.mjs ` file which defines custom
4+ directives that will save some time authoring certain repeated elements.
5+
6+ ## Git commit checkpoint directive
7+
8+ ``` myst
9+ :::{gitCommitCheckpoint} my commit message
10+ :::
11+ ```
12+
13+ :::{gitCommitCheckpoint} my commit message
14+ :::
15+
16+
17+ ## "You should notice..." directive
18+
19+ `````` myst
20+ :::{youShouldNotice}
21+ ...the `{youShouldNotice}` directive fully supports markdown in the body.
22+ This means you can, for example include some code:
23+
24+ ```python
25+ print("Some code!")
26+ ```
27+ :::
28+ ``````
29+
30+ :::{youShouldNotice}
31+ ...the ` {youShouldNotice} ` directive fully supports markdown in the body.
32+ This means you can, for example include some code:
33+
34+ ``` python
35+ print (" Some code!" )
36+ ```
37+ :::
Original file line number Diff line number Diff line change @@ -209,6 +209,30 @@ E.g.:
209209:::
210210```
211211
212+ ** As a shortcut, you can use the ` {youShouldNotice} ` directive.**
213+ See [ ] ( ./helpers.md ) .
214+
215+
216+ #### Committing
217+
218+ Use 💾 in a callout to indicate that the user should stop and do a commit now.
219+ Provide the full set of commands the user should run.
220+
221+ `````` {myst}
222+ :::{important} 💾 Commit & push to GitHub
223+ :icon: false
224+
225+ ```bash
226+ git add .
227+ git commit -m "Commit message"
228+ git push -u origin main
229+ ```
230+ :::
231+ ``````
232+
233+ ** As a shortcut, you can use the ` {gitCommitCheckpoint} ` directive.**
234+ See [ ] ( ./helpers.md ) .
235+
212236
213237### Voice / language
214238
You can’t perform that action at this time.
0 commit comments