Skip to content

Commit

Permalink
Add pkgdown build to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ismayc committed May 27, 2020
1 parent d556073 commit 7febd70
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 5 deletions.
6 changes: 6 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
^.*\.Rproj$
^\.Rproj\.user$
R/.setup.R
^_pkgdown\.yml$
^docs$
^pkgdown$
^images$
^LICENSE\.md$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
.DS_Store
inst/rmarkdown/templates/thesis/skeleton/_book/*
inst/rmarkdown/templates/thesis/skeleton/_bookdown_files/*
docs
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: thesisdown
Title: An updated R Markdown thesis template using the bookdown package
Version: 0.1.0.9000
Version: 0.1.0
Authors@R: c(
person("Chester", "Ismay", email = "chester.ismay@gmail.com", role = "cre"),
person("Nick", "Solomon", email = "nick@nicksolomon.me", role = "aut"))
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# thesisdown <img src="images/thesisdown_hex.png" align="right" width=125 />
# thesisdown <img src="man/figures/thesisdown_hex.png" align="right" width=200 />

This project was inspired by the [bookdown](https://github.com/rstudio/bookdown) package and is an updated version of my Senior Thesis template in the `reedtemplates` package [here](https://github.com/ismayc/reedtemplates). It was originally designed to only work with the Reed College LaTeX template, but has since been adapted to work with many different institutions by many different individuals. Check out the [**Customizing thesisdown to your institution**](https://github.com/ismayc/thesisdown#customizing-thesisdown-to-your-institution) section below for examples.

Expand Down Expand Up @@ -87,9 +87,9 @@ Note that you may need to restart RStudio at this point for the following dialog

3) Use the **New R Markdown** dialog to select **Thesis**:

![New R Markdown](images/thesis_rmd.png)
![New R Markdown](images/thesis_rmd.png)

Note that this will currently only **Knit** if you name the directory `index` as shown above. This guarantees that `index.html` is generated correctly for the Gitbook version of the thesis.
Note that this will currently only **Knit** if you name the directory `index` as shown above. This guarantees that `index.html` is generated correctly for the Gitbook version of the thesis.

4) After choosing which type of output you'd like in the YAML at the top of index.Rmd, **Knit** the `index.Rmd` file to get the book in PDF or HTML formats.

Expand Down Expand Up @@ -127,7 +127,7 @@ Store your bibliography (as bibtex files) here. We recommend using the [citr add
### `csl/`

Specific style files for bibliographies should be stored here. A good source for
citation styles is https://github.com/citation-style-language/styles#readme
citation styles is https://github.com/citation-style-language/styles#readme.

### `figure/` and `data/`

Expand Down
File renamed without changes.
File renamed without changes

0 comments on commit 7febd70

Please sign in to comment.