diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 412a1d0..52c5b1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ We welcome contributions to the **tufte** package. To submit a contribution: 1. [Fork](https://github.com/rstudio/tufte/fork) the repository and make your changes. -2. Ensure that you have signed the [individual](http://www.rstudio.com/wp-content/uploads/2014/06/RStudioIndividualContributorAgreement.pdf) or [corporate](http://www.rstudio.com/wp-content/uploads/2014/06/RStudioCorporateContributorAgreement.pdf) contributor agreement as appropriate. You can send the signed copy to jj@rstudio.com. +2. Ensure that you have signed the [individual](https://www.rstudio.com/wp-content/uploads/2014/06/RStudioIndividualContributorAgreement.pdf) or [corporate](https://www.rstudio.com/wp-content/uploads/2014/06/RStudioCorporateContributorAgreement.pdf) contributor agreement as appropriate. You can send the signed copy to jj@rstudio.com. 3. Submit a [pull request](https://help.github.com/articles/using-pull-requests). diff --git a/NEWS.md b/NEWS.md index c0ecfc7..9ce153e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -44,7 +44,7 @@ ## BUG FIXES -- When `link-citations: no` in YAML, citations should not be moved into the page margin in the HTML output (http://stackoverflow.com/q/39053097/559676). +- When `link-citations: no` in YAML, citations should not be moved into the page margin in the HTML output (https://stackoverflow.com/q/39053097/559676). - Horizontal lines could bisect margin notes and footnotes (thanks, @ajdamico, #32). diff --git a/R/handout.R b/R/handout.R index bd6b877..fb66dcf 100644 --- a/R/handout.R +++ b/R/handout.R @@ -10,7 +10,7 @@ #' \code{\link{html_document}} (note you cannot use the \code{template} #' argument in \code{tufte_handout} or the \code{theme} argument in #' \code{tufte_html()}; these arguments have been set internally) -#' @references See \url{http://rstudio.github.io/tufte} for an example. +#' @references See \url{https://rstudio.github.io/tufte/} for an example. #' @export #' @examples library(tufte) tufte_handout = function( diff --git a/README.md b/README.md index 65950d4..4482d6b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # tufte [![Build Status](https://travis-ci.org/rstudio/tufte.svg)](https://travis-ci.org/rstudio/tufte) -[![Downloads from the RStudio CRAN mirror](http://cranlogs.r-pkg.org/badges/tufte)](https://cran.r-project.org/package=tufte) +[![Downloads from the RStudio CRAN mirror](https://cranlogs.r-pkg.org/badges/tufte)](https://cran.r-project.org/package=tufte) This R package provides a few R Markdown output formats that use the Tufte style. See https://rstudio.github.io/tufte/ for a comprehensive example. To install the development version of this package from Github, you may use `devtools::install_github('rstudio/tufte')`. You can also install it from [CRAN](https://cran.r-project.org/package=tufte) (`install.packages('tufte')`). diff --git a/inst/rmarkdown/templates/tufte_html/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/tufte_html/skeleton/skeleton.Rmd index 14baabc..b2f3fa9 100644 --- a/inst/rmarkdown/templates/tufte_html/skeleton/skeleton.Rmd +++ b/inst/rmarkdown/templates/tufte_html/skeleton/skeleton.Rmd @@ -41,13 +41,13 @@ There are two goals of this package: 1. To produce both PDF and HTML output with similar styles from the same R Markdown document; 1. To provide simple syntax to write elements of the Tufte style such as side notes and margin figures, e.g. when you want a margin figure, all you need to do is the chunk option `fig.margin = TRUE`, and we will take care of the details for you, so you never need to think about `\begin{marginfigure} \end{marginfigure}` or ` `; the LaTeX and HTML code under the hood may be complicated, but you never need to learn or write such code. -If you have any feature requests or find bugs in **tufte**, please do not hesitate to file them to https://github.com/rstudio/tufte/issues. For general questions, you may ask them on StackOverflow: http://stackoverflow.com/tags/rmarkdown. +If you have any feature requests or find bugs in **tufte**, please do not hesitate to file them to https://github.com/rstudio/tufte/issues. For general questions, you may ask them on StackOverflow: https://stackoverflow.com/tags/rmarkdown. # Headings This style provides first and second-level headings (that is, `#` and `##`), demonstrated in the next section. You may get unexpected output if you try to use `###` and smaller headings. -`r newthought('In his later books')`^[[Beautiful Evidence](http://www.edwardtufte.com/tufte/books_be)], Tufte starts each section with a bit of vertical space, a non-indented paragraph, and sets the first few words of the sentence in small caps. To accomplish this using this style, call the `newthought()` function in **tufte** in an _inline R expression_ `` `r ` `` as demonstrated at the beginning of this paragraph.^[Note you should not assume **tufte** has been attached to your R session. You should either `library(tufte)` in your R Markdown document before you call `newthought()`, or use `tufte::newthought()`.] +`r newthought('In his later books')`^[[Beautiful Evidence](https://www.edwardtufte.com/tufte/books_be)], Tufte starts each section with a bit of vertical space, a non-indented paragraph, and sets the first few words of the sentence in small caps. To accomplish this using this style, call the `newthought()` function in **tufte** in an _inline R expression_ `` `r ` `` as demonstrated at the beginning of this paragraph.^[Note you should not assume **tufte** has been attached to your R session. You should either `library(tufte)` in your R Markdown document before you call `newthought()`, or use `tufte::newthought()`.] # Figures @@ -105,7 +105,7 @@ Any _full width_ content here. Below is an example: ::: {.fullwidth} -_R is free software and comes with ABSOLUTELY NO WARRANTY._ You are welcome to redistribute it under the terms of the GNU General Public License versions 2 or 3. For more information about these matters see http://www.gnu.org/licenses/. +_R is free software and comes with ABSOLUTELY NO WARRANTY._ You are welcome to redistribute it under the terms of the GNU General Public License versions 2 or 3. For more information about these matters see https://www.gnu.org/licenses/. ::: ## Main Column Figures @@ -124,7 +124,7 @@ If you'd like to place ancillary information in the margin without the sidenote # References -References can be displayed as margin notes for HTML output. For example, we can cite R here [@R-base]. To enable this feature, you must set `link-citations: yes` in the YAML metadata, and the version of `pandoc-citeproc` should be at least 0.7.2. You can always install your own version of Pandoc from http://pandoc.org/installing.html if the version is not sufficient. To check the version of `pandoc-citeproc` in your system, you may run this in R: +References can be displayed as margin notes for HTML output. For example, we can cite R here [@R-base]. To enable this feature, you must set `link-citations: yes` in the YAML metadata, and the version of `pandoc-citeproc` should be at least 0.7.2. You can always install your own version of Pandoc from https://pandoc.org/installing.html if the version is not sufficient. To check the version of `pandoc-citeproc` in your system, you may run this in R: ```{r eval=FALSE} system2('pandoc-citeproc', '--version') @@ -250,7 +250,7 @@ output: css: "my_style.css" ``` -There is also a variant of the Tufte style in HTML/CSS named "[Envisoned CSS](http://nogginfuel.com/envisioned-css/)". This style can be used by specifying the argument `tufte_variant = 'envisioned'` in `tufte_html()`^[The actual Envisioned CSS was not used in the **tufte** package. We only changed the fonts, background color, and text color based on the default Tufte style.], e.g. +There is also a variant of the Tufte style in HTML/CSS named "[Envisoned CSS](https://github.com/nogginfuel/envisioned-css)". This style can be used by specifying the argument `tufte_variant = 'envisioned'` in `tufte_html()`^[The actual Envisioned CSS was not used in the **tufte** package. We only changed the fonts, background color, and text color based on the default Tufte style.], e.g. ```yaml output: @@ -268,7 +268,7 @@ file.edit( ) ``` -This document is also available in [Chinese](http://rstudio.github.io/tufte/cn/), and its `envisioned` style can be found [here](http://rstudio.github.io/tufte/envisioned/). +This document is also available in [Chinese](https://rstudio.github.io/tufte/cn/), and its `envisioned` style can be found [here](https://rstudio.github.io/tufte/envisioned/). ```{r bib, include=FALSE} # create a bib file for the R packages used in this document diff --git a/man/tufte_handout.Rd b/man/tufte_handout.Rd index c92e563..5bbb810 100644 --- a/man/tufte_handout.Rd +++ b/man/tufte_handout.Rd @@ -115,5 +115,5 @@ library(tufte) newthought("In this section") } \references{ -See \url{http://rstudio.github.io/tufte} for an example. +See \url{https://rstudio.github.io/tufte/} for an example. }