Add checkpoints to commit and push using custom plugin

Author: mfisher87

modules/05-sharing-and-publishing/index.md

@@ -49,12 +49,6 @@ We'll publish the website and PDF for free on GitHub, and enable automatic gener
 DOIs for our published product.
 :::
 
-:::{note} TODOs
-:class: dropdown
-
-* Add checkpoints to commit and push
-:::
-
 
 ## What is MyST?
 
@@ -162,6 +156,8 @@ process.
 ::::::{hint} Joining late? You may need to clone the workshop repository
 :class: dropdown
 
+Foo!
+
 If you're joining late, you may have missed a prior instruction to clone the workshop
 website and set up GitHub authentication.
 
@@ -440,7 +436,7 @@ site:
 
 #### 🧪 Rebuild your site
 
-**Save and rebuild your site.**
+Save and rebuild your site.
 
 :::{important} 👀 You should notice...
 :class: simple
@@ -492,7 +488,7 @@ site:
 
 #### 🧪 Rebuild your site
 
-**Save and rebuild your site.**
+Save and rebuild your site.
 
 :::{important} 👀 You should notice...
 :class: simple
@@ -502,6 +498,9 @@ site:
 chose for your logo text) instead of "Made with MyST".
 :::
 
+:::{gitCommitCheckpoint} Initialize MyST site
+:::
+
 
 #### 🧠 What do we know now?
 
@@ -682,13 +681,20 @@ Double-click `paper.pdf` in the JupyterLab file browser.
 There is a title page, a blank table of contents, and then your content on the 3rd page.
 :::
 
+:::{gitCommitCheckpoint} Add PDF export
+:::
+
+:::{note} Other PDF templates
+:class: dropdown
+
 This document was rendered with the `"plain_typst_book"` template.
 Other PDF template options are available!
 
 Try running `myst templates list --typst` to see a list of available templates.
 
 More information is available on the
 [official MyST PDF-building documentation](https://mystmd.org/guide/creating-pdf-documents).
+:::
 
 
 #### 🧠 What do we know now?
@@ -767,6 +773,9 @@ browser.
 Select View > Show hidden files** from the menu.
 :::
 
+:::{gitCommitCheckpoint} Set up publish with GitHub Actions
+:::
+
 
 #### 🧪 View the action results
 
@@ -989,6 +998,9 @@ myst build --cff
 ```
 :::
 
+:::{gitCommitCheckpoint} Add CITATION.cff for Zenodo DOI
+:::
+
 As your project grows and changes, you can regenerate this file by repeating
 that command.
 

myst.yml

@@ -7,6 +7,8 @@ project:
   # authors: []
   license: "MIT"
   github: "https://github.com/geojupyter/workshop-open-source-geospatial"
+  plugins:
+    - "plugin-custom-directives.mjs"
   error_rules:
     - rule: "doi-link-valid"
       severity: "warn"

plugin-custom-directives.mjs

@@ -0,0 +1,39 @@
+const gitCommitDirective = {
+  name: "gitCommitCheckpoint",
+  doc: "Renders a consistent callout when the learner should do a Git commit.",
+  arg: {
+    type: String,
+    doc: "Commit message",
+  },
+  run(data) {
+    return [{
+      type: "block",
+      children: [{
+        type: "admonition",
+        kind: "important",
+        icon: false,
+        children: [
+          {
+            type: "admonitionTitle",
+            children: [{
+              type: "text",
+              value: "💾 Commit & push to GitHub",
+            }],
+          },
+          {
+            type: "code",
+            lang: "bash",
+            value: `git add .\ngit commit -m "${data.arg}"\ngit push -u origin main`,
+          },
+        ],
+      }],
+    }]
+  },
+};
+
+const plugin = {
+  name: "Our custom functionality",
+  doc: "Custom functionality for this workshop website",
+  directives: [gitCommitDirective],
+}
+export default plugin;