You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 0010-cheatsheet.Rmd
+11-5Lines changed: 11 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -60,19 +60,25 @@ This section is a quick reference on setting up GitHub Pages site for workshops.
60
60
Add your pre-work, schedule, and faculty details. When slides and lab materials are ready, include them in their respective modules.
61
61
62
62
# Editing Your Workshop {#editing-cheatsheet}
63
-
1.[If you don't already have your repo cloned:](#clone)
63
+
1.[If you don't already have your repo cloned:](#clone)
64
64
65
65
* On your repo page on GitHub's website, click the green Code button, ensure SSH is selected, and copy the text in the box
66
66
* On your local machine, open your terminal and navigate to the folder where you store your CBW Github repos
67
67
* Run ``git clone [THE TEXT YOU JUST COPIED]``
68
68
69
-
2. Make any changes you like
69
+
2.Make any changes you like, but don't forget:
70
70
71
-
3.[Click Build to create the HTML files that make up the website](#finishing-touches)
71
+
:::: {.callout type="red" title="Remember to pull first!" style="subtle" icon="fas fa-circle-info"}
72
+
73
+
**Remember to always run `git pull` before making changes**. It doesn't matter if you do this in RStudio or the command line, but it will save you serious headaches down the road.
74
+
75
+
::::
72
76
73
-
4.[Commit and push](#finishing-touches)
77
+
3.[Click Build to create the HTML files that make up the website](#finishing-touches)
74
78
75
-
5. Your website will be ready in 1-2 minutes
79
+
4.[Commit and push](#finishing-touches)
80
+
81
+
5. Your website will be ready in 1-2 minutes
76
82
77
83
For more details on this process, see the Reference Materials section below.
Copy file name to clipboardExpand all lines: 0036-whatsnext.Rmd
+12Lines changed: 12 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,12 @@
2
2
3
3
Now that you have your repo set up, you can start filling it out! Some of the details you'll need to include are below.
4
4
5
+
:::: {.callout type="red" title="Remember to pull first!" style="subtle" icon="fas fa-circle-info"}
6
+
7
+
**Remember to always run `git pull` before making changes**. It doesn't matter if you do this in RStudio or the command line, but it will save you serious headaches down the road.
8
+
9
+
::::
10
+
5
11
## Homepage
6
12
The index.Rmd file creates your landing page, which has a few different components.
7
13
@@ -98,6 +104,12 @@ Copy the below code chunk and paste into your slide. Replace `YOUTUBE EMBED LINK
98
104
### Adding lab material
99
105
RCs and faculty can add lab material directly into your bookdown website. Use the details in the Formatting section below to include features like code chunks, callouts, and images.
100
106
107
+
## Bioschemas
108
+
The `_bioschemas.html` file contains the Bioschemas metadata. It is mostly complete, but you'll need to update:
109
+
110
+
**inLanguage* if the language is not English
111
+
**keywords* with 3-5 keywords
112
+
101
113
## What if I need to add a new file or change the existing file structure?
102
114
Bookdown renders the Rmd files in the main repo in alphabetical order, hence the numbers at the beginning of each file. To create a new file, simply name it starting with the numbers that place it where you want it in your output website.
Copy file name to clipboardExpand all lines: 020-reference.Rmd
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# (PART) Reference Material {-}
2
2
3
+
# Command line crash course {#command-line}
4
+
3
5
# Bookdown crash course {#bookdown-crash-course}
4
6
5
7
Here is a general summary of how Bookdown creates html websites from .Rmd files when you hit Build.
@@ -269,3 +271,4 @@ Now, we're done! We should see the updates on GitHub now. Also note, if we ever
269
271
270
272
Git pushing will automatically update the website, you can see the updates and progress in the actions window we saw previously. (Check out your website on the web once it's done deploying!)
0 commit comments