This is a template for creating an HTML GitBook style bookdown book, hosted on GitHub Pages. It is based on the one created with File, New Project..., New Directory, Book Project using bookdown in RStudio. It assumes you know how to use git/GitHub and R Markdown, and have some familiarity with the bookdown package. If you don't, the package author Yihue Xie's RStudio webinar Introduction to Bookdown (R Package) provides an excellent introduction. In addition, check out bookdown: Authoring Books and Technical Documents with R Markdown, also by Yihui Xie, both for the content and the format--it is itself a bookdown book.
Follow these instructions and you will have a published bookdown book in less than five minutes. If you have any difficulties or have feedback of any kind, please file an issue.
- 1. Click the green "Use this template" button above. DO NOT FORK THE REPO. Choose a descriptive name for your repo based on your content. (Unlike when you fork a repo, you get to choose the name. If you change your mind before you do any work, delete your new repo and start over.)
-
1. On the home page of your repo, click Settings. Scroll down to the GitHub pages section and change Source to master branch /docs folder. Above the Source line, a bar will appear with your book's URL. The bar will initially be blue and indicate that your book is ready to be published and will change to green once it is published. Copy the URL. (Note that sometimes there is a delay until your book actually appears at that URL. If it doesn't appear after a few minutes, try making a small change locally, rendering the book, and pushing the changes to trigger a deploy.)
-
2. Click the gear button near "About" on the home page of the repo and paste your book URL into the Website field that appears on the right.
-
3. Make a change to the repo and commit it, such as deleting the steps in this README that you've already completed. This will trigger GitHub Pages to publish the website.
Once you've completed these steps, delete the content of this README and add a short description of your project with a link to the book URL. It would be appreciated if you add "This repo was initially generated from a bookdown template available here: https://github.com/jtr13/bookdown-template" to the end of the README.
- 1. Clone your new repo with File, New Project..., Version Control, Git in RStudio.
-
1. In
index.Rmd, change YOUR TITLE HERE to your title. -
2. In
index.Rmd, change YOUR NAME HERE to your name. -
3. In
_bookdown.yml, change YOUR GITHUB USERNAME to your GitHub username in the two places it appears. -
4. In
_bookdown.yml, change YOUR GITHUB REPO to your GitHub repo name in the two places it appears.
(Note that 3. and 4. provide links to the .Rmd files of your project for editing and viewing. If you move your .Rmd files you will need to update these file paths. Once your book is rendered, test that the edit (pen) and view (eye) buttons work.)
- 5. In
_output.yml, change YOUR SHORT TITLE to a shortened version of your title. (Leave the "after:" line indicating that the book was published with bookdown as is.)
-
1. Install bookdown with
install.packages("bookdown"). If you already have it, update to the latest version. -
2. Render locally with
bookdown::render_book("index.Rmd"). -
3. Use
browseURL("docs/index.html")to view your book locally (or just openindex.htmlin a browser). -
4. If it looks good, commit and push all changed files to GitHub.
(You will need to repeat steps 2 and 4 every time you wish to update the book online.)
A demo video showing how to create a bookdown book following these instructions: http://bit.ly/5minutebookdown
Please consult the official guide to bookdown: https://bookdown.org/yihui/bookdown