Skip to content

Commit f3da7ac

Browse files
Push for Canelle and Ben
1 parent e74c786 commit f3da7ac

34 files changed

+2073
-562
lines changed

.Rproj.user/9462ED09/pcs/files-pane.pper

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
22
"sortOrder": [
3-
{
4-
"columnIndex": 4,
5-
"ascending": false
6-
},
73
{
84
"columnIndex": 2,
95
"ascending": true
6+
},
7+
{
8+
"columnIndex": 4,
9+
"ascending": false
1010
}
1111
],
1212
"path": "~/Documents/CBWGithub/bookdown-guide"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"activeTab": 6
2+
"activeTab": 5
33
}

.Rproj.user/9462ED09/sources/prop/INDEX

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
~%2FDocuments%2FCBWGithub%2Fbookdown-guide%2F0033-faculty.Rmd="4240BBAF"
1212
~%2FDocuments%2FCBWGithub%2Fbookdown-guide%2F0034-clone.Rmd="4C99AC25"
1313
~%2FDocuments%2FCBWGithub%2Fbookdown-guide%2F0034-finishingtouches.Rmd="CCF0636F"
14+
~%2FDocuments%2FCBWGithub%2Fbookdown-guide%2F0035-finishingtouches.Rmd="8DF09C6D"
1415
~%2FDocuments%2FCBWGithub%2Fbookdown-guide%2F0036-whatsnext.Rmd="1E2FAB72"
1516
~%2FDocuments%2FCBWGithub%2Fbookdown-guide%2F016-last.Rmd="7DC9A443"
1617
~%2FDocuments%2FCBWGithub%2Fbookdown-guide%2F020-reference.Rmd="712294FF"

.Rproj.user/shared/notebooks/paths

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
/Users/nhughes/Documents/CBWGithub/bookdown-guide/0033-faculty.Rmd="25E83ABE"
77
/Users/nhughes/Documents/CBWGithub/bookdown-guide/0034-clone.Rmd="47832F6D"
88
/Users/nhughes/Documents/CBWGithub/bookdown-guide/0034-finishingtouches.Rmd="9FA243AD"
9+
/Users/nhughes/Documents/CBWGithub/bookdown-guide/0035-finishingtouches.Rmd="0C0F301B"
910
/Users/nhughes/Documents/CBWGithub/bookdown-guide/0036-whatsnext.Rmd="4F28809C"
1011
/Users/nhughes/Documents/CBWGithub/bookdown-guide/016-last.Rmd="C5070CAB"
1112
/Users/nhughes/Documents/CBWGithub/bookdown-guide/020-reference.Rmd="0587BF6F"

0010-cheatsheet.Rmd

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,19 +60,25 @@ This section is a quick reference on setting up GitHub Pages site for workshops.
6060
Add your pre-work, schedule, and faculty details. When slides and lab materials are ready, include them in their respective modules.
6161

6262
# 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)
6464

6565
* On your repo page on GitHub's website, click the green Code button, ensure SSH is selected, and copy the text in the box
6666
* On your local machine, open your terminal and navigate to the folder where you store your CBW Github repos
6767
* Run ``git clone [THE TEXT YOU JUST COPIED]``
6868

69-
2. Make any changes you like
69+
2. Make any changes you like, but don't forget:
7070

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+
::::
7276

73-
4. [Commit and push](#finishing-touches)
77+
3. [Click Build to create the HTML files that make up the website](#finishing-touches)
7478

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
7682

7783
For more details on this process, see the Reference Materials section below.
7884

0036-whatsnext.Rmd

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
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.
44

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+
511
## Homepage
612
The index.Rmd file creates your landing page, which has a few different components.
713

@@ -98,6 +104,12 @@ Copy the below code chunk and paste into your slide. Replace `YOUTUBE EMBED LINK
98104
### Adding lab material
99105
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.
100106

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+
101113
## What if I need to add a new file or change the existing file structure?
102114
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.
103115

016-last.Rmd

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# (PART) Formatting {-}
2-
<!-- ![Image showing how to ](img/template/.png)\
3-
<br>-->
2+
3+
# Markdown {#markdown}
44

55

66
# Callouts {#callouts}
@@ -70,22 +70,22 @@ You can override any of these defaults by specifying a different icon class, for
7070

7171
Here are some practical examples you can copy and adapt.
7272

73-
### Example 1: Static Informational Note
73+
### Example 1: Informational Note
7474

75-
A standard blue callout for providing information.
75+
A subtle blue callout for providing information.
7676

7777
```markdown
78-
:::: {.callout type="blue" title="Information"}
78+
:::: {.callout type="blue" title="Information" style="subtle"}
7979

80-
This is a standard blue informational callout.
80+
This is a blue informational callout using the Subtle styling.
8181
The default icon for 'blue' will be used.
8282

8383
::::
8484
```
8585

86-
:::: {.callout type="blue" title="Information"}
86+
:::: {.callout type="blue" title="Information" style="subtle"}
8787

88-
This is a standard blue informational callout.
88+
This is a blue informational callout using the Subtle styling.
8989
The default icon for 'blue' will be used.
9090

9191
::::
@@ -227,3 +227,10 @@ You can nest callouts inside other elements, such as lists, by indenting the ent
227227
::::
228228

229229
3. This is the third item in the list, appearing after the callout.
230+
231+
232+
233+
# Code {#code}
234+
235+
236+

020-reference.Rmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# (PART) Reference Material {-}
22

3+
# Command line crash course {#command-line}
4+
35
# Bookdown crash course {#bookdown-crash-course}
46

57
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
269271

270272
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!)
271273

274+
# Danger zones {#danger-zones}

_output.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ bookdown::gitbook:
1414
<a href="https://bioinformaticsdotca.github.io/">
1515
<img src="img/bioinformatics_logo.png" width="90%" alt="bioinformatics.ca logo" style="display:block; margin-left:auto; margin-right:auto; margin-top:15px;">
1616
</a>
17-
<li><center><strong><a href="./"><br>CBW Bookdown Guide<br><br></a></strong></center></li>
18-
<br>
17+
<li><center><strong><a href="./"><br>CBW Bookdown Guide</a></strong></center></li>
1918
2019
after: |
2120
<h1 id="sponsors">Sponsors</h1>

0 commit comments

Comments
 (0)