CBW's Bookdown Template Documentation
CBW’s Bookdown Documentation
I Cheat Sheet
Regional Coordinator Crash Course
Create your repo
Give your team access
Instructor Crash Course
Clone your repo
Getting Started
Program Installations
Creating the SSH Connection
Generating a new SSH key
[Linux/Mac] Adding your SSH key to the ssh-agent
[Windows] Adding your SSH key to the ssh-agent
Adding a new SSH key to your account
Getting the Template on Your Local Computer - Git Clone!
Oops, I Git Cloned the Wrong Repository and I Want to Delete it from my Local Computer!
New Workshop
: Creation [RC] and Deployment
Setup the Workshop [RC]
Workshop Repo VS Workshop Website
How to Deploy Your Workshop Website
Check Your Deploy and See your Website!
Setting Up Team Access [RC?] (Nia will fill this in)
Recurring Workshop
: Copying [RC] and Deployment
Recreate the Workshop
Deploying Your Workshop Website
Making Updates
Command Line, SSH Connection & Git Clone
Introduction to the Command Line
Terminal, Command Prompt and Windows PowerShell
Common Commands (for us)
So What Do These Files Mean?
Bookdown Simple Explanation
Opening Your Bookdown Project in RStudio
Explaining RStudio
Build the Book
Other Ways to Build Your Book
Knit Your Book
Preview Your Book
File Setup Explanation
Push to GitHub via RStudio
Formatting Your Content - Markdown
Visaul R Markdown
Chapters
Subheader
Subheader
An unnumbered subheader
Parts
Text Formatting
Bold
Italics
Subscript
Superscript
Footnotes
Horizontal Line
Blockquote
Unordered List
Ordered List
Code
Images
PDFs
Inserting YouTube Videos
Links
Links to Other Pages/Sections within your Workshop Wesbite
Citations
Equations
Theorems and Proofs
Callout blocks
TIP: Markdown Not Working/Not Enough? Use HTML!
How to Render/Compile Code
Rendering Code
Rendering Code with Highlights for Specific Languages
Rendering and Compiling Code
Code Chunk Options
Code Chunks for Code-Generated Figures and Tables
Brain Dump / FAQ
Danger Zones
Potential Errors & Bugs
Ease of Use
Wrapping Your Code
Visual R Markdown
FAQs
II DEVELOPERS GUIDE
Developer’s Guide
Build Site
How to edit _bookdown.yml
How to edit _output.yml (RC)
Mandatory “index.Rmd” landing page
Build the book:
Render book
Preview book
Git Instructions
How to Make a Git Repo (RC)
How to Make the Git Connection (Adding your Local Repo to GitHub)
Updating GitHub via RStudio
How to Deploy Your Workshop Website
Appendix [Links for Developers]
GitHub Repo
Diagram Links
How to Publish a Google Drawing
Published with bookdown
CBW’s Bookdown Template Documentation
Instructor Crash Course
Clone your repo
Your coordinator will have already created your repository.