From 7febd70b98ae6e8d104bf1080e066468d030b968 Mon Sep 17 00:00:00 2001 From: Chester Ismay Date: Wed, 27 May 2020 16:32:01 -0700 Subject: [PATCH] Add pkgdown build to docs --- .Rbuildignore | 6 ++++++ .gitignore | 1 + DESCRIPTION | 2 +- README.md | 8 ++++---- .../templates/thesis/skeleton/.here => _pkgdown.yml | 0 {images => man/figures}/thesisdown_hex.png | Bin 6 files changed, 12 insertions(+), 5 deletions(-) rename inst/rmarkdown/templates/thesis/skeleton/.here => _pkgdown.yml (100%) rename {images => man/figures}/thesisdown_hex.png (100%) diff --git a/.Rbuildignore b/.Rbuildignore index 91114bf2..be33a4e6 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,8 @@ ^.*\.Rproj$ ^\.Rproj\.user$ +R/.setup.R +^_pkgdown\.yml$ +^docs$ +^pkgdown$ +^images$ +^LICENSE\.md$ diff --git a/.gitignore b/.gitignore index a08e3f52..7f8ce2c5 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .DS_Store inst/rmarkdown/templates/thesis/skeleton/_book/* inst/rmarkdown/templates/thesis/skeleton/_bookdown_files/* +docs diff --git a/DESCRIPTION b/DESCRIPTION index fa1e15d3..a72febdc 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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")) diff --git a/README.md b/README.md index d7d4c104..1f82dff2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# thesisdown +# thesisdown 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. @@ -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. @@ -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/` diff --git a/inst/rmarkdown/templates/thesis/skeleton/.here b/_pkgdown.yml similarity index 100% rename from inst/rmarkdown/templates/thesis/skeleton/.here rename to _pkgdown.yml diff --git a/images/thesisdown_hex.png b/man/figures/thesisdown_hex.png similarity index 100% rename from images/thesisdown_hex.png rename to man/figures/thesisdown_hex.png