@@ -4,8 +4,10 @@ title: "💪 Exercise"
44
55### Step 1: Set up GitHub Pages
66
7- 1 . Open your repository on GitHub.
8- 1 . Click "⚙️ Settings" towards the top of the page.
7+ 1 . ** Open your repository on GitHub** .
8+ 1 . ** Click "⚙️ Settings"** towards the top of the page.
9+ 1 . ** Select "Pages"** on the left.
10+ 1 . ** Switch GitHub Pages to use GitHub Actions as the build & deployment source** :
911 ![ ] ( ../../assets/images/github-pages-settings.png )
1012
1113All of the other scaffolding you need is already included in this repo in the
@@ -14,10 +16,11 @@ When you build your own MyST website, you can reproduce this with `myst init --s
1416` myst init --gh-pages ` .
1517
1618
17- ### Step 2: Make a change & push to GitHub
19+ ### Step 2: Make a change & save to GitHub
1820
19- 1 . Edit any file in ` examples/module-3/my-website ` .
20- 1 . Commit and push:
21+ 1 . ** Edit ` index.md ` ** in ` examples/module-3/my-website ` .
22+ Add any content you like!
23+ 1 . ** Commit and push** :
2124
2225 ``` bash
2326 git add .
@@ -27,21 +30,50 @@ When you build your own MyST website, you can reproduce this with `myst init --s
2730
2831# ## Step 3: View your new GitHub Pages deployment!
2932
30- 1. In your repository, view the GitHub Actions progress.
33+ 1. In your repository, ** view the GitHub Actions progress** .
3134 1. From the repository home page, click the " Actions" tab towards the top.
3235 1. You should see an action titled " Edit to trigger GitHub Pages deployment" , matching
3336 the commit message from the previous step.
3437 Is it complete (green check)?
3538 Or is it still in progress?
3639 Did it fail (red X)? Let us know if it failed.
37- 1. View your website. Check that the change you made in the previous step is visible!
38- * Your website will be available at this URL (replace ` MY-USERNAME` with your username
40+ 1. ** View your website** . Check that the change you made in the previous step is visible!
41+ * Your website will be available at this URL (replace ` MY-USERNAME` with your username
3942😉):
4043
4144 ` ` `
4245 https://MY-USERNAME.github.io/workshop-csdms2025-examples
4346 ` ` `
4447
45- # ## Step 4: Edit your notebook to display some data (WIP)
48+ 1. ** View the page titled " I am an example notebook" ** .
49+ This notebook is rendered as a website, including interactive elements!
4650
47- _TODO_
51+
52+ # ## Step 4: Edit your notebook to display some data
53+
54+ 1. ** Edit the file ` examples/module-3/my-website/example.ipynb` in JupyterHub** .
55+ 1. Modify the 2nd code cell to add GeoJSON data to the website.
56+ ** Add the following code to the 2nd to last line, before ` m` ** :
57+
58+ ` ` ` python
59+ folium.GeoJson(" seec_and_nsidc.json" ).add_to(m)
60+ ` ` `
61+
62+ 1. ** Save your notebook** .
63+
64+
65+ # ## Step 5: Save to GitHub
66+
67+ ` ` ` bash
68+ git add .
69+ git commit --message=" Display data in notebook"
70+ git push origin main
71+ ` ` `
72+
73+
74+ # ## Step 6: View your website!
75+
76+ It may take a minute or two; don' t forget, you can view the progress in the "Actions"
77+ tab of your repository.
78+
79+ Check the example notebook rendered correctly on the website.
0 commit comments