bioinformatics.ca logo
  • 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

Appendix [Links for Developers]

For the developers of this guide, here are helpful sources.

GitHub Repo

The Bookdown Docs are hosted from the cbw-dev/bookdown-docs public repository.

Diagram Links

Most diagrams shown on these docs should be in this Google folder.

How to Publish a Google Drawing

  1. Open the drawing.

  2. Edit.

    Tip: Editing size of the Google Drawing is very easy when you drag the diagonal lines in the bottom right corner.

  3. To publish, go to “File > Share > Publish to Web > Embed”. Copy the “Medium” (optional) image size HTML code. Paste where you want it to appear in your .Rmd file.

  4. Add alt text to the img embed code: Add alt="Alt Text" after src = ... and before >.

Warning:

If you’re putting a screenshot into your Google Drawing, the resolution of the image will look very poor when it is rendered. You can fix this by simply making the image extremely big.

Note: Lots of the GitHub clone/deploy/RStudio explaining images are currently locally in the repository, and not on the Google drive.

References (the below citation list is auto-generated since we showed examples of citations)

Xie, Yihui. 2025. Bookdown: Authoring Books and Technical Documents with r Markdown. https://github.com/rstudio/bookdown.