├── .gitattributes
├── .gitignore
├── 02-tears.Rmd
├── 03-race.Rmd
├── LICENSE
├── README.md
├── _bookdown.yml
├── _output.yml
├── docs
├── a-caucus-race-and-a-long-tale.html
├── index.html
├── libs
│ ├── gitbook-2.6.7
│ │ ├── css
│ │ │ ├── fontawesome
│ │ │ │ └── fontawesome-webfont.ttf
│ │ │ ├── plugin-bookdown.css
│ │ │ ├── plugin-clipboard.css
│ │ │ ├── plugin-fontsettings.css
│ │ │ ├── plugin-highlight.css
│ │ │ ├── plugin-search.css
│ │ │ ├── plugin-table.css
│ │ │ └── style.css
│ │ └── js
│ │ │ ├── app.min.js
│ │ │ ├── clipboard.min.js
│ │ │ ├── jquery.highlight.js
│ │ │ ├── lunr.js
│ │ │ ├── plugin-bookdown.js
│ │ │ ├── plugin-clipboard.js
│ │ │ ├── plugin-fontsettings.js
│ │ │ ├── plugin-search.js
│ │ │ └── plugin-sharing.js
│ └── jquery-2.2.3
│ │ └── jquery.min.js
├── search_index.json
├── style.css
└── the-pool-of-tears.html
├── index.Rmd
└── style.css
/.gitattributes:
--------------------------------------------------------------------------------
1 | *.css linguist-detectable=false
2 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .Rhistory
2 | .RData
3 | .Rproj.user
4 | *.Rproj
5 | _bookdown_files/
6 |
--------------------------------------------------------------------------------
/02-tears.Rmd:
--------------------------------------------------------------------------------
1 | # The pool of tears
2 |
3 |
--------------------------------------------------------------------------------
/03-race.Rmd:
--------------------------------------------------------------------------------
1 | # A caucus-race and a long tale
2 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 Joyce Robbins
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | This is a template for creating an [HTML GitBook style](https://bookdown.org/yihui/bookdown/html.html#gitbook-style) **[bookdown](https://github.com/rstudio/bookdown)** book, [hosted on GitHub Pages](https://bookdown.org/yihui/bookdown/github.html). 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)](https://www.youtube.com/watch?v=dVqVscgwSpw)* provides an excellent introduction. In addition, check out [*bookdown: Authoring Books and Technical Documents with R Markdown*](https://bookdown.org/yihui/bookdown), also by Yihui Xie, both for the content and the format--it is itself a **bookdown** book.
2 | If you need help getting git/GitHub to work with RStudio see: [Happy Git and GitHub for the useR](https://happygitwithr.com/) by Jenny Bryan.
3 |
4 |
5 | ## ABSOLUTE ESSENTIALS
6 |
7 | *If you have any difficulties or have feedback of any kind, please file an issue or communicate through [Discussions](https://github.com/jtr13/bookdown-template/discussions).*
8 |
9 | ### Copy this template (GitHub)
10 |
11 | - [ ] 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.)
12 |
13 | ### Set up Pages (GitHub)
14 |
15 | - [ ] 1. On the home page of your repo, click Settings. Click the "Pages" section on the left. In the **Build and Deployment** section, set **Source** to "Deploy from a branch" (Classic Pages experience) and **Branch** to **main** with **/docs** folder. Click Save. Above the **Build and Deployment** section, a box will appear with your book's URL. 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, make a change and commit it to trigger a GitHub Pages build.)
16 |
17 | - [ ] 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.
18 |
19 | ### Copy the repo link (GitHub)
20 |
21 | - [ ] 1. Click the green Code button and copy the link under HTTPS. It should have the format: `https://github.com/[USERNAME]/[REPO NAME].git`
22 |
23 | ### Clone the repo (RStudio)
24 |
25 | - [ ] 1. Clone your new repo with *File, New Project..., Version Control, Git* in RStudio. You will need to paste the link from the previous step in the Repository URL box.
26 |
27 | ### Edit some key files (RStudio)
28 |
29 | - [ ] 1. In `index.Rmd`, change YOUR TITLE HERE to your title.
30 |
31 | - [ ] 2. In `index.Rmd`, change YOUR NAMES HERE to your names.
32 |
33 | - [ ] 3. In `_bookdown.yml`, change YOUR GITHUB USERNAME to your GitHub username in the two places it appears.
34 |
35 | - [ ] 4. In `_bookdown.yml`, change YOUR GITHUB REPO to your GitHub repo name in the two places it appears.
36 |
37 | (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.)
38 |
39 | - [ ] 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.)
40 |
41 | ### Render the book (RStudio)
42 |
43 | - [ ] 1. Install **bookdown** with `install.packages("bookdown")`. If you already have it, update to the most recent version.
44 |
45 | - [ ] 2. Render locally with `bookdown::render_book("index.Rmd")` or clicking the *Build book* button which should appear in the Build tab (in the same pane as Environment, History, Connections, ...).
46 |
47 | - [ ] 3. Use `browseURL("docs/index.html")` to view your book locally (or just open `index.html` in a browser).
48 |
49 | - [ ] 4. If it looks good, commit and push all changed files to GitHub.
50 |
51 | (You will need to repeat steps 2 and 4 every time you wish to update the book online.)
52 |
53 | ### Edit README (GitHub or RStudio)
54 |
55 | 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 the following to the end:
56 |
57 | *This repo was initially generated from a bookdown template available here: https://github.com/jtr13/bookdown-template.*
58 |
59 | (And starring the repo would be nice too!)
60 |
61 | ### Demo Video
62 |
63 | A demo video showing how to create a **bookdown book** following these instructions: http://bit.ly/fiveminutebookdown
64 |
65 | ### Additional features
66 |
67 | Please consult the official guide to **bookdown**: https://bookdown.org/yihui/bookdown
68 |
69 |
--------------------------------------------------------------------------------
/_bookdown.yml:
--------------------------------------------------------------------------------
1 | book_filename: "bookdownproj"
2 | output_dir: docs
3 | delete_merged_file: true
4 | edit: https://github.com/YOUR GITHUB USERNAME/YOUR REPO NAME/edit/main/%s
5 | view: https://github.com/YOUR GITHUB USERNAME/YOUR REPO NAME/blob/main/%s
6 | language:
7 | ui:
8 | chapter_name: "Chapter "
9 |
--------------------------------------------------------------------------------
/_output.yml:
--------------------------------------------------------------------------------
1 | bookdown::gitbook:
2 | css: style.css
3 | config:
4 | toc:
5 | before: |
6 |