Developed by First Last.
"
5 |
6 | $right
7 | [1] "
7 | RoxygenNote: 6.1.1
8 | Encoding: UTF-8
9 |
--------------------------------------------------------------------------------
/tests/testthat/assets/reference-fail/man/f.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/f.R
3 | \name{f}
4 | \alias{f}
5 | \title{Title}
6 | \usage{
7 | f()
8 | }
9 | \description{
10 | Title
11 |
12 | \url{}
13 | }
14 |
--------------------------------------------------------------------------------
/tests/testthat/assets/site-citation/multi/inst/CITATION:
--------------------------------------------------------------------------------
1 | bibentry("misc", title="Proof of b < a > c", author=c("A", "B"), year="2021",
2 | textVersion="A & B (2021): Proof of b < a > c.")
3 | bibentry("misc", title="Title Two", author="Author Two", year="2022")
4 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/development.md:
--------------------------------------------------------------------------------
1 | # bad mode yields good error
2 |
3 | Code
4 | check_mode("foo")
5 | Condition
6 | Error in `check_mode()`:
7 | ! `development.mode` in `_pkgdown.yml` must be one of auto, default, release, devel, unreleased
8 |
9 |
--------------------------------------------------------------------------------
/tests/testthat/test-topics-external.R:
--------------------------------------------------------------------------------
1 | test_that("can get info about external function", {
2 | expect_snapshot(str(ext_topics("base::mean")))
3 | })
4 |
5 | test_that("fails if documentation not available", {
6 | expect_snapshot(ext_topics("base::doesntexist"), error = TRUE)
7 | })
8 |
--------------------------------------------------------------------------------
/inst/BS3/templates/content-home.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {{{index}}}
4 |
5 |
6 |
11 |
xx
2 |
3 |
6 |
7 |
8 | {{#tutorials}}
9 | {{title}}
12 |
13 |
abc
4 |
5 | # can process footnote with code
6 |
7 | Code
8 | xpath_attr(html, ".//a", "data-bs-content")
9 | Output
10 | [1] "Including code:
\n1 +\n2 +And more text
"
11 |
12 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph-customized/DESCRIPTION:
--------------------------------------------------------------------------------
1 | Package: testpackage
2 | Version: 1.0.0
3 | Title: A test package
4 | Description: A longer statement about the package.
5 | Authors@R: c(
6 | person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre")),
7 | person("RStudio", role = c("cph", "fnd"))
8 | )
9 | RoxygenNote: 6.1.1
10 | Encoding: UTF-8
11 |
--------------------------------------------------------------------------------
/tests/testthat/assets/reference-pre-post/DESCRIPTION:
--------------------------------------------------------------------------------
1 | Package: testpackage
2 | Version: 1.0.0
3 | Title: A test package
4 | Description: A longer statement about the package.
5 | Authors@R: c(
6 | person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre")),
7 | person("RStudio", role = c("cph", "fnd"))
8 | )
9 | RoxygenNote: 6.1.1
10 | Encoding: UTF-8
11 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph-customized/vignettes/no-description.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: No Description
3 | opengraph:
4 | twitter:
5 | card: summary
6 | creator: "@dataandme"
7 | output: rmarkdown::html_vignette
8 | vignette: >
9 | %\VignetteIndexEntry{No Description}
10 | %\VignetteEngine{knitr::rmarkdown}
11 | %\VignetteEncoding{UTF-8}
12 | ---
13 |
14 | Content goes here
15 |
--------------------------------------------------------------------------------
/tests/testthat/assets/tutorials/vignettes/tutorials/test-1/tutorial-test-1.dcf:
--------------------------------------------------------------------------------
1 | name: tutorial-test-1
2 | title: tutorial-test-1
3 | username:
4 | account: hadley
5 | server: shinyapps.io
6 | hostUrl: https://api.shinyapps.io/v1
7 | appId: 305391
8 | bundleId: 1282758
9 | url: https://hadley.shinyapps.io/tutorial-test-1/
10 | when: 1521734722.72611
11 | asMultiple: FALSE
12 | asStatic: FALSE
13 |
--------------------------------------------------------------------------------
/R/check.R:
--------------------------------------------------------------------------------
1 | #' Check `_pkgdown.yml`
2 | #'
3 | #' Check that your `_pkgdown.yml` is valid without building the whole
4 | #' site.
5 | #'
6 | #' @export
7 | #' @inheritParams as_pkgdown
8 | check_pkgdown <- function(pkg = ".") {
9 | pkg <- as_pkgdown(pkg)
10 |
11 | data_open_graph(pkg)
12 | data_articles_index(pkg)
13 | data_reference_index(pkg)
14 |
15 | inform("No problems found")
16 | }
17 |
18 |
--------------------------------------------------------------------------------
/tests/testthat/assets/articles/vignettes/html-document.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "html_document + as_is"
3 | output:
4 | html_document:
5 | number_sections: true
6 | pkgdown:
7 | as_is: true
8 | ---
9 |
10 | ```{r include = FALSE}
11 | knitr::opts_chunk$set(collapse = TRUE, comment = "#>")
12 | ```
13 |
14 | This should have section numbers on the headings.
15 |
16 | # Heading 1
17 |
18 | # Heading 2
19 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph/DESCRIPTION:
--------------------------------------------------------------------------------
1 | Package: testpackage
2 | Version: 1.0.0
3 | Title: A test package
4 | Description: A longer statement about the package.
5 | Authors@R: c(
6 | person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre")),
7 | person("RStudio", role = c("cph", "fnd"))
8 | )
9 | RoxygenNote: 6.1.1
10 | Encoding: UTF-8
11 | URL: http://example.com/pkg/
12 |
--------------------------------------------------------------------------------
/man/check_pkgdown.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/check.R
3 | \name{check_pkgdown}
4 | \alias{check_pkgdown}
5 | \title{Check \verb{_pkgdown.yml}}
6 | \usage{
7 | check_pkgdown(pkg = ".")
8 | }
9 | \arguments{
10 | \item{pkg}{Path to package.}
11 | }
12 | \description{
13 | Check that your \verb{_pkgdown.yml} is valid without building the whole
14 | site.
15 | }
16 |
--------------------------------------------------------------------------------
/man/in_pkgdown.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/pkgdown.R
3 | \name{in_pkgdown}
4 | \alias{in_pkgdown}
5 | \title{Determine if code is executed by pkgdown}
6 | \usage{
7 | in_pkgdown()
8 | }
9 | \description{
10 | This is occasionally useful when you need different behaviour by
11 | pkgdown and regular documentation.
12 | }
13 | \examples{
14 | in_pkgdown()
15 | }
16 |
--------------------------------------------------------------------------------
/tests/testthat/assets/man-figures/DESCRIPTION:
--------------------------------------------------------------------------------
1 | Package: kittens
2 | Version: 1.0.0
3 | Title: A test package
4 | Description: A longer statement about the package.
5 | Authors@R: c(
6 | person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre")),
7 | person("RStudio", role = c("cph", "fnd"))
8 | )
9 | RoxygenNote: 6.0.1
10 | Suggests:
11 | knitr,
12 | rmarkdown
13 | VignetteBuilder: knitr
14 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph/vignettes/open-graph.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | author: "Hadley Wickham"
3 | title: "Introduction to Open Graph"
4 | description: "The Open Graph protocol is a standard for web page metadata."
5 | output: rmarkdown::html_vignette
6 | vignette: >
7 | %\VignetteIndexEntry{Introduction to Open Graph}
8 | %\VignetteEngine{knitr::rmarkdown}
9 | %\VignetteEncoding{UTF-8}
10 | ---
11 |
12 | Content goes here
13 |
--------------------------------------------------------------------------------
/R/tweak.R:
--------------------------------------------------------------------------------
1 | has_class <- function(html, class) {
2 | classes <- strsplit(xml2::xml_attr(html, "class"), " ")
3 | purrr::map_lgl(classes, ~ any(class %in% .x))
4 | }
5 |
6 | tweak_class_prepend <- function(x, class) {
7 | if (length(x) == 0) {
8 | return(invisible())
9 | }
10 |
11 | cur <- xml2::xml_attr(x, "class")
12 | xml2::xml_attr(x, "class") <- ifelse(is.na(cur), class, paste(class, cur))
13 | invisible()
14 | }
15 |
--------------------------------------------------------------------------------
/tests/testthat/assets/site-bad-logo/DESCRIPTION:
--------------------------------------------------------------------------------
1 | Package: testpackage
2 | Version: 1.0.0
3 | Title: A test package
4 | Description: The logo.png file in this package is empty and can't be
5 | converted to favicons by the API.
6 | Authors@R: c(
7 | person("Hadley", "Wickham", , "hadley@rstudio.com", role = c("aut", "cre")),
8 | person("RStudio", role = c("cph", "fnd"))
9 | )
10 | RoxygenNote: 6.1.1
11 | Encoding: UTF-8
12 |
--------------------------------------------------------------------------------
/tests/testthat/test-sitrep.R:
--------------------------------------------------------------------------------
1 | test_that("pkgdown_sitrep works", {
2 | # URL not in the pkgdown config
3 | pkg <- test_path("assets/figure")
4 | expect_snapshot_output(pkgdown_sitrep(pkg))
5 | # URL only in the pkgdown config
6 | pkg <- test_path("assets/cname")
7 | expect_snapshot_output(pkgdown_sitrep(pkg))
8 | # URL everywhere
9 | pkg <- test_path("assets/open-graph")
10 | expect_snapshot_output(pkgdown_sitrep(pkg))
11 | })
12 |
--------------------------------------------------------------------------------
/inst/BS3/templates/content-title-body.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
6 |
7 | {{{body}}}
8 |
9 |
10 |
11 |
16 |
17 |
2 |
3 |
6 |
7 |
8 |
9 | {{#translate}}{{on_this_page}}{{/translate}}
10 |
11 |
12 |
2 |
3 |
8 |
9 | {{{body}}}
10 |
11 |
12 |
13 |
14 |
15 | {{#translate}}{{on_this_page}}{{/translate}}
16 |
17 |
18 |
19 |
2 |
3 |
8 |
9 | {{#contents}}
10 | {{{html}}}
11 | {{/contents}}
12 |
13 |
14 |
15 |
16 | {{#translate}}{{on_this_page}}{{/translate}}
17 |
18 |
19 |
20 |
2 |
3 |
6 |
7 | {{#sections}}
8 |
9 |
{{{title}}}
10 |
{{{desc}}}
11 |
12 |
13 | {{#contents}}
14 | {{title}} {{{description}}}
16 | {{/contents}}
17 |
18 |
19 | {{/sections}}
20 |
21 |
2 |
3 |
7 |
8 | {{#contents}}
9 | {{{html}}}
10 | {{/contents}}
11 |
12 |
13 |
18 |
19 |
2 |
3 |
7 |
8 |
9 | {{#tutorials}}
10 | {{title}}
13 |
14 |
15 |
16 |
17 | {{#translate}}{{on_this_page}}{{/translate}}
18 |
19 |
20 |
A & B (2021): Proof of b < a > c.
"
6 |
7 | [[1]]$bibtex
8 | [1] "@Misc{,\n title = {Proof of b < a > c},\n author = {{A} and {B}},\n year = {2021},\n}"
9 |
10 |
11 | [[2]]
12 | [[2]]$html
13 | [1] "Two A (2022).\n“Title Two.” \n
"
14 |
15 | [[2]]$bibtex
16 | [1] "@Misc{,\n title = {Title Two},\n author = {Author Two},\n year = {2022},\n}"
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/check.md:
--------------------------------------------------------------------------------
1 | # fails if reference index incomplete
2 |
3 | Code
4 | check_pkgdown(pkg)
5 | Condition
6 | Error in `check_missing_topics()`:
7 | ! All topics must be included in reference index
8 | * Missing topics: ?
9 |
10 | # fails if article index incomplete
11 |
12 | Code
13 | check_pkgdown(pkg)
14 | Condition
15 | Error in `data_articles_index()`:
16 | ! Vignettes missing from index:
17 |
18 | # informs if everything is ok
19 |
20 | Code
21 | check_pkgdown(pkg)
22 | Message
23 | No problems found
24 |
25 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/repo.md:
--------------------------------------------------------------------------------
1 | # repo_source() truncates automatically
2 |
3 | Code
4 | cat(repo_source(pkg, character()))
5 | cat(repo_source(pkg, "a"))
6 | Output
7 | Source: aabc
2 |
3 |
7 |
12 |
13 |
14 |
15 |
16 | {{#translate}}{{on_this_page}}{{/translate}}
17 |
18 |
19 |
{{#translate}}{{skip}}{{/translate}}
11 | {{{ before-body }}}
12 | {{{ navbar }}}
13 |
14 | {{{ content }}}
15 |
16 |
19 |
20 |
21 | {{{ docsearch }}}
22 |
23 | {{{ after-body }}}
24 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/man/as_pkgdown.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/package.R
3 | \name{as_pkgdown}
4 | \alias{as_pkgdown}
5 | \title{Generate pkgdown data structure}
6 | \usage{
7 | as_pkgdown(pkg = ".", override = list())
8 | }
9 | \arguments{
10 | \item{pkg}{Path to package.}
11 |
12 | \item{override}{An optional named list used to temporarily override
13 | values in \verb{_pkgdown.yml}}
14 | }
15 | \description{
16 | You will generally not need to use this unless you need a custom site
17 | design and you're writing your own equivalent of \code{\link[=build_site]{build_site()}}.
18 | }
19 |
--------------------------------------------------------------------------------
/tests/testthat/assets/man-figures/vignettes/kitten.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "kitten"
3 | output: rmarkdown::html_vignette
4 | vignette: >
5 | %\VignetteIndexEntry{kitten}
6 | %\VignetteEngine{knitr::rmarkdown}
7 | %\VignetteEncoding{UTF-8}
8 | ---
9 |
10 | ```{r, include = FALSE}
11 | knitr::opts_chunk$set(
12 | collapse = TRUE,
13 | comment = "#>"
14 | )
15 | ```
16 |
17 | ## `knitr::include_graphics()`
18 |
19 | ``` {r}
20 | knitr::include_graphics("../man/figures/kitten.jpg")
21 | ```
22 |
23 | ## rmarkdown
24 |
25 | 
26 |
27 | ## Another kitten
28 |
29 | 
30 |
--------------------------------------------------------------------------------
/man/index.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/test.R
3 | \name{index}
4 | \alias{index}
5 | \alias{test-index}
6 | \title{Index}
7 | \description{
8 | Index
9 | }
10 | \seealso{
11 | Other tests:
12 | \code{\link{test-crayon}},
13 | \code{\link{test-dont}},
14 | \code{\link{test-figures}},
15 | \code{\link{test-links}},
16 | \code{\link{test-lists}},
17 | \code{\link{test-long-lines}},
18 | \code{\link{test-output-styles}},
19 | \code{\link{test-params}},
20 | \code{\link{test-sexpr-title}},
21 | \code{\link{test-verbatim}}
22 | }
23 | \concept{tests}
24 | \keyword{internal}
25 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph-customized/vignettes/open-graph.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | author: "Mara Averick"
3 | title: "Introduction to Open Graph"
4 | description: "The Open Graph protocol is a standard for web page metadata."
5 | opengraph:
6 | description: This should be ignored
7 | image:
8 | src: "http://example.com/pkg/batpig.png"
9 | twitter:
10 | card: summary
11 | creator: "@dataandme"
12 | output: rmarkdown::html_vignette
13 | vignette: >
14 | %\VignetteIndexEntry{Introduction to Open Graph}
15 | %\VignetteEngine{knitr::rmarkdown}
16 | %\VignetteEncoding{UTF-8}
17 | ---
18 |
19 | Content goes here
20 |
--------------------------------------------------------------------------------
/tests/testthat/test-deploy-site.R:
--------------------------------------------------------------------------------
1 | # ci_commit_sha() ------------------------------------------------------------
2 |
3 | test_that("commit sha can be retrieved from travis or GitHub action env vars", {
4 | sha <- "XYZ"
5 |
6 | withr::with_envvar(
7 | c("TRAVIS_COMMIT" = sha, "GITHUB_SHA" = ""),
8 | expect_equal(ci_commit_sha(), sha)
9 | )
10 | withr::with_envvar(
11 | c("TRAVIS_COMMIT" = "", "GITHUB_SHA" = sha),
12 | expect_equal(ci_commit_sha(), sha)
13 | )
14 | withr::with_envvar(
15 | c("TRAVIS_COMMIT" = "", "GITHUB_SHA" = ""),
16 | expect_equal(ci_commit_sha(), "")
17 | )
18 | })
19 |
--------------------------------------------------------------------------------
/R/build-404.R:
--------------------------------------------------------------------------------
1 | build_404 <- function(pkg = ".") {
2 | pkg <- as_pkgdown(pkg)
3 |
4 | # if this file exists, it will be handled by build_home_md()
5 | page_md <- path(pkg$src_path, ".github", "404.md")
6 |
7 | if (!file_exists(page_md)) {
8 | render_page(
9 | pkg, "title-body",
10 | data = list(
11 | pagetitle = tr_("Page not found (404)"),
12 | body = tr_("Content not found. Please use links in the navbar.")
13 | ),
14 | path = "404.html"
15 | )
16 | update_html(path_abs("404.html", start = pkg$dst_path), tweak_link_absolute, pkg = pkg)
17 | }
18 |
19 | invisible()
20 | }
21 |
--------------------------------------------------------------------------------
/inst/BS3/templates/layout.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | {{{ head }}}
6 | {{{ in-header }}}
7 |
8 |
9 |
10 | {{{ before-body }}}
11 |
12 |
13 | {{{ navbar }}}
14 | {{{ header }}}
15 |
16 |
17 | {{{ content }}}
18 |
19 |
22 |
23 |
24 | {{{ docsearch }}}
25 |
26 | {{{ after-body }}}
27 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/vignettes/test/widgets.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "HTML widgets"
3 | ---
4 |
5 | ```{r, include = FALSE}
6 | knitr::opts_chunk$set(
7 | collapse = TRUE,
8 | comment = "#>"
9 | )
10 | ```
11 |
12 | ## Widgets
13 |
14 | Test spacing above widget.
15 |
16 | ```{r, echo=FALSE}
17 | # set seed for reproducible widget id
18 | if (requireNamespace("htmltools", quietly = TRUE)) {
19 | htmlwidgets::setWidgetIdSeed(42)
20 | }
21 |
22 | path1 <- tempfile()
23 | writeLines(letters, path1)
24 | path2 <- tempfile()
25 | writeLines(letters[-(10:11)], path2)
26 |
27 | diffviewer::visual_diff(path1, path2)
28 | ```
29 |
30 | Test spacing below widget.
31 |
--------------------------------------------------------------------------------
/tests/testthat/test-build-github.R:
--------------------------------------------------------------------------------
1 | test_that("a CNAME record is built if a url exists in metadata", {
2 | pkg <- local_pkgdown_site(test_path("assets/cname"))
3 |
4 | dir_create(path(pkg$dst_path, "docs"))
5 | expect_output(build_github_pages(pkg))
6 | expect_equal(read_lines(path(pkg$dst_path, "CNAME")), "testpackage.r-lib.org")
7 | })
8 |
9 | test_that("CNAME URLs are valid", {
10 | expect_equal(cname_url("http://google.com/"), "google.com")
11 | expect_equal(cname_url("https://google.com/"), "google.com")
12 |
13 | # this is not a valid URL because it has a trailing path
14 | expect_null(cname_url("http://google.com/path/"))
15 | })
16 |
--------------------------------------------------------------------------------
/tests/testthat/test-utils-yaml.R:
--------------------------------------------------------------------------------
1 | test_that("pkgdown_field(s) produces useful description", {
2 | pkg <- local_pkgdown_site()
3 | file_touch(file.path(pkg$src_path, "_pkgdown.yml"))
4 |
5 | expect_snapshot({
6 | pkgdown_field(pkg, c("a", "b"))
7 | pkgdown_fields(pkg, list(c("a", "b"), "c"))
8 | })
9 | })
10 |
11 | test_that("pkgdown_field(s) produces useful description", {
12 | pkg <- local_pkgdown_site()
13 | file_touch(file.path(pkg$src_path, "_pkgdown.yml"))
14 |
15 | expect_snapshot(error = TRUE, {
16 | check_yaml_has("x", where = "a", pkg = pkg)
17 | check_yaml_has(c("x", "y"), where = "a", pkg = pkg)
18 | })
19 | })
20 |
--------------------------------------------------------------------------------
/man/rd2html.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/rd.R
3 | \name{rd2html}
4 | \alias{rd2html}
5 | \title{Translate an Rd string to its HTML output}
6 | \usage{
7 | rd2html(x, fragment = TRUE, ...)
8 | }
9 | \arguments{
10 | \item{x}{Rd string. Backslashes must be double-escaped ("\\\\").}
11 |
12 | \item{fragment}{logical indicating whether this represents a complete Rd file}
13 |
14 | \item{...}{additional arguments for as_html}
15 | }
16 | \description{
17 | Translate an Rd string to its HTML output
18 | }
19 | \examples{
20 | rd2html("a\n\%b\nc")
21 |
22 | rd2html("a & b")
23 |
24 | rd2html("\\\\strong{\\\\emph{x}}")
25 |
26 | }
27 |
--------------------------------------------------------------------------------
/man/test-params.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/test.R
3 | \name{test-params}
4 | \alias{test-params}
5 | \title{Test case: params}
6 | \arguments{
7 | \item{...}{ellipsis}
8 | }
9 | \description{
10 | Test case: params
11 | }
12 | \seealso{
13 | Other tests:
14 | \code{\link{index}},
15 | \code{\link{test-crayon}},
16 | \code{\link{test-dont}},
17 | \code{\link{test-figures}},
18 | \code{\link{test-links}},
19 | \code{\link{test-lists}},
20 | \code{\link{test-long-lines}},
21 | \code{\link{test-output-styles}},
22 | \code{\link{test-sexpr-title}},
23 | \code{\link{test-verbatim}}
24 | }
25 | \concept{tests}
26 | \keyword{internal}
27 |
--------------------------------------------------------------------------------
/tests/testthat/test-figure.R:
--------------------------------------------------------------------------------
1 | test_that("can override defaults in _pkgdown.yml", {
2 | skip_if_no_pandoc()
3 | withr::local_temp_libpaths()
4 |
5 | pkg <- local_pkgdown_site(test_path("assets/figure"))
6 |
7 | callr::rcmd("INSTALL", pkg$src_path, show = FALSE, fail_on_status = TRUE)
8 |
9 | expect_output(build_reference(pkg, devel = FALSE))
10 | img <- path_file(dir_ls(path(pkg$dst_path, "reference"), glob = "*.jpg"))
11 | expect_setequal(img, c("figure-1.jpg", "figure-2.jpg"))
12 |
13 | expect_output(build_articles(pkg))
14 | img <- path_file(dir_ls(path(pkg$dst_path, "articles"), glob = "*.jpg", recurse = TRUE))
15 | expect_equal(img, "unnamed-chunk-1-1.jpg")
16 | })
17 |
--------------------------------------------------------------------------------
/man/test-sexpr-title.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/test.R
3 | \name{test-sexpr-title}
4 | \alias{test-sexpr-title}
5 | \title{Test case: \Sexpr[stage=render,results=rd]{"sexpr"}}
6 | \description{
7 | Test case: \Sexpr[stage=render,results=rd]{"sexpr"}
8 | }
9 | \seealso{
10 | Other tests:
11 | \code{\link{index}},
12 | \code{\link{test-crayon}},
13 | \code{\link{test-dont}},
14 | \code{\link{test-figures}},
15 | \code{\link{test-links}},
16 | \code{\link{test-lists}},
17 | \code{\link{test-long-lines}},
18 | \code{\link{test-output-styles}},
19 | \code{\link{test-params}},
20 | \code{\link{test-verbatim}}
21 | }
22 | \concept{tests}
23 | \keyword{internal}
24 |
--------------------------------------------------------------------------------
/inst/BS3/templates/docsearch.html:
--------------------------------------------------------------------------------
1 | {{#yaml}}{{#docsearch}}
2 |
3 |
18 | {{/docsearch}}{{/yaml}}
19 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/utils-yaml.md:
--------------------------------------------------------------------------------
1 | # pkgdown_field(s) produces useful description
2 |
3 | Code
4 | pkgdown_field(pkg, c("a", "b"))
5 | Output
6 | [1] "a.b in '_pkgdown.yml'"
7 | Code
8 | pkgdown_fields(pkg, list(c("a", "b"), "c"))
9 | Output
10 | [1] "a.b, c in '_pkgdown.yml'"
11 |
12 | ---
13 |
14 | Code
15 | check_yaml_has("x", where = "a", pkg = pkg)
16 | Condition
17 | Error in `check_yaml_has()`:
18 | ! Can't find component a.x in '_pkgdown.yml'.
19 | Code
20 | check_yaml_has(c("x", "y"), where = "a", pkg = pkg)
21 | Condition
22 | Error in `check_yaml_has()`:
23 | ! Can't find components a.x, a.y in '_pkgdown.yml'.
24 |
25 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/topics-external.md:
--------------------------------------------------------------------------------
1 | # can get info about external function
2 |
3 | Code
4 | str(ext_topics("base::mean"))
5 | Output
6 | tibble [1 x 6] (S3: tbl_df/tbl/data.frame)
7 | $ name : chr "base::mean"
8 | $ file_out: chr "https://rdrr.io/r/base/mean.html"
9 | $ title : chr "Arithmetic Mean (from base)"
10 | $ funs :List of 1
11 | ..$ : chr "mean()"
12 | $ alias :List of 1
13 | ..$ : chr(0)
14 | $ internal: logi FALSE
15 |
16 | # fails if documentation not available
17 |
18 | Code
19 | ext_topics("base::doesntexist")
20 | Condition
21 | Error in `.f()`:
22 | ! Could not find documentation for base::doesntexist
23 |
24 |
--------------------------------------------------------------------------------
/inst/highlight-styles/monochrome.scss:
--------------------------------------------------------------------------------
1 | pre code span.al /* Alert */ {font-weight: bold}
2 | pre code span.an /* Annotation */ {font-style: italic}
3 | pre code span.cf /* ControlFlow */ {font-weight: bold}
4 | pre code span.co /* Comment */ {font-style: italic}
5 | pre code span.cv /* CommentVar */ {font-style: italic}
6 | pre code span.do /* Documentation */ {font-style: italic}
7 | pre code span.dt /* DataType */ {text-decoration: underline}
8 | pre code span.er /* Error */ {font-weight: bold}
9 | pre code span.in /* Information */ {font-style: italic}
10 | pre code span.kw /* Keyword */ {font-weight: bold}
11 | pre code span.pp /* Preprocessor */ {font-weight: bold}
12 | pre code span.wa /* Warning */ {font-style: italic}
13 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/tweak-homepage.md:
--------------------------------------------------------------------------------
1 | # can remove logo
2 |
3 | Code
4 | xpath_xml(html, ".//div")
5 | Output
6 |
9 |
10 | ---
11 |
12 | Code
13 | xpath_xml(html, ".//div")
14 | Output
15 |
18 |
19 | # can move badges to sidebar
20 |
21 | Code
22 | xpath_xml(html, ".//div")
23 | Output
24 |
25 |
Dev status
26 |
27 |
29 |
LGPL-2 "
9 | )
10 |
11 | expect_equal(
12 | autolink_license("MPL-2.0"),
13 | "MPL-2.0 "
14 | )
15 | })
16 |
17 | test_that("link_license matches LICENSE", {
18 | expect_equal(
19 | autolink_license("LICENSE"),
20 | "LICENSE "
21 | )
22 | expect_equal(
23 | autolink_license("LICENCE"),
24 | "LICENCE "
25 | )
26 | })
27 |
--------------------------------------------------------------------------------
/tests/testthat/test-check.R:
--------------------------------------------------------------------------------
1 | test_that("fails if reference index incomplete", {
2 | pkg <- local_pkgdown_site(test_path("assets/reference"), meta = "
3 | reference:
4 | - title: Title
5 | contents: [a, b, c, e]
6 | ")
7 | expect_snapshot(check_pkgdown(pkg), error = TRUE)
8 | })
9 |
10 |
11 | test_that("fails if article index incomplete", {
12 | pkg <- local_pkgdown_site(test_path("assets/articles"), meta = "
13 | articles:
14 | - title: Title
15 | contents: [starts_with('html'), standard, toc-false, widget]
16 | ")
17 | expect_snapshot(check_pkgdown(pkg), error = TRUE)
18 | })
19 |
20 | test_that("informs if everything is ok", {
21 | pkg <- local_pkgdown_site(test_path("assets/reference"))
22 | expect_snapshot(check_pkgdown(pkg))
23 | })
24 |
--------------------------------------------------------------------------------
/inst/BS5/templates/content-authors.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 |
8 |
9 | {{{before}}}
10 |
18 | {{{after}}}
19 |
21 |
22 |
23 |
24 | {{#translate}}{{on_this_page}}{{/translate}}
25 |
26 |
27 |
2 |
3 |
7 |
8 | {{#sections}}
9 |
10 |
{{{title}}}
11 |
{{{desc}}}
12 |
13 |
14 | {{#contents}}
15 | {{title}} {{{description}}}
17 | {{/contents}}
18 |
19 |
22 |
23 |
24 |
25 | {{#translate}}{{on_this_page}}{{/translate}}
26 |
27 |
28 |
5 |
8 |
13 |
--------------------------------------------------------------------------------
/inst/BS5/assets/link.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
5 |
8 |
13 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/build-home-authors.md:
--------------------------------------------------------------------------------
1 | # data_home_sidebar_authors() works with text
2 |
3 | Code
4 | cat(data_home_sidebar_authors(pkg))
5 | Output
6 |
7 |
Developers
8 |
9 | yay
10 | Hadley Wickham Author, maintainer
12 | RStudio Copyright holder, funder
14 | cool
15 | More about authors...
17 |
}}\preformatted{magrittr::subtract(10, 1)
8 | }\if{html}{\out{
}}
9 |
10 | \if{html}{\out{}}\preformatted{## [1] 9
11 | }\if{html}{\out{
}}
12 | }
13 | \examples{
14 | magrittr::subtract(10, 1)
15 |
16 | library(magrittr, warn.conflicts = FALSE)
17 | subtract(10, 1)
18 | }
19 | \seealso{
20 | Other tests:
21 | \code{\link{index}},
22 | \code{\link{test-crayon}},
23 | \code{\link{test-dont}},
24 | \code{\link{test-figures}},
25 | \code{\link{test-lists}},
26 | \code{\link{test-long-lines}},
27 | \code{\link{test-output-styles}},
28 | \code{\link{test-params}},
29 | \code{\link{test-sexpr-title}},
30 | \code{\link{test-verbatim}}
31 | }
32 | \concept{tests}
33 | \keyword{internal}
34 |
--------------------------------------------------------------------------------
/inst/BS3/templates/content-citation-authors.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
7 |
8 | {{{before}}}
9 |
17 | {{{after}}}
18 |
19 |
20 |
21 |
Citation
22 | {{#source}}{{{.}}} {{/source}}
23 |
24 |
25 |
26 |
27 | {{#citations}}
28 | {{{html}}}
29 |
{{{bibtex}}}
30 | {{/citations}}
31 |
32 |
33 |
34 |
lifecycle lifecycle stable stable lifecycle lifecycle defunct defunct lifecycle lifecycle archived archived lifecycle lifecycle maturing maturing }}\preformatted{figures:
22 | other.parameters:
23 | rgl:
24 | fig.asp: 1
25 | }\if{html}{\out{
}}
26 | }
27 | \keyword{internal}
28 |
--------------------------------------------------------------------------------
/man/figures/lifecycle-deprecated.svg:
--------------------------------------------------------------------------------
1 | lifecycle lifecycle deprecated deprecated lifecycle lifecycle superseded superseded lifecycle lifecycle experimental experimental lifecycle lifecycle questioning questioning
2 |
3 |
7 |
8 | {{#rows}}
9 | {{#title}}
{{{.}}} {{/title}}
10 | {{#subtitle}}
{{{.}}} {{/subtitle}}
11 | {{#desc}}
{{{desc}}}
{{/desc}}
12 |
13 | {{#topics}}
14 |
15 | {{#has_icons}}{{#icon}}{{{.}}}
18 | {{{title}}}
19 | {{/topics}}
20 |
22 |
23 |
24 |
25 | {{#translate}}{{on_this_page}}{{/translate}}
26 |
27 |
28 |
#> X
24 |
25 |
--------------------------------------------------------------------------------
/tests/testthat/test-utils.R:
--------------------------------------------------------------------------------
1 | test_that("pkgdown.internet can be set and read", {
2 | options(pkgdown.internet = FALSE)
3 | expect_false(has_internet())
4 | })
5 |
6 | test_that("cran_unquote works", {
7 | expect_equal(cran_unquote("Quoting is CRAN's thing."),
8 | "Quoting is CRAN's thing.")
9 | expect_equal(cran_unquote("'R-hub' is great!"),
10 | "R-hub is great!")
11 | expect_equal(cran_unquote("From 'README' to 'html' with 'pkgdown'"),
12 | "From README to html with pkgdown")
13 | })
14 |
15 | test_that("is_internal_link() works", {
16 | pkg=list(meta=list(url="https://pkgdown.r-lib.org"))
17 | expect_false(is_internal_link("https://github.com", pkg = pkg))
18 | expect_false(is_internal_link("http://github.com", pkg = pkg))
19 | expect_true(is_internal_link("https://pkgdown.r-lib.org/articles", pkg = pkg))
20 | expect_true(is_internal_link("reference/index.html", pkg = pkg))
21 | expect_true(
22 | all.equal(
23 | is_internal_link(c("reference/index.html", "https://github.com"), pkg = pkg),
24 | c(TRUE, FALSE)
25 | )
26 | )
27 | })
28 |
--------------------------------------------------------------------------------
/R/build-home-community.R:
--------------------------------------------------------------------------------
1 | has_contributing <- function(path = ".") {
2 | file_exists(path(path, 'CONTRIBUTING.md')) ||
3 | file_exists(path(path, '.github', 'CONTRIBUTING.md'))
4 | }
5 |
6 | has_coc <- function(path = ".") {
7 | file_exists(path(path, 'CODE_OF_CONDUCT.md')) ||
8 | file_exists(path(path, '.github', 'CODE_OF_CONDUCT.md'))
9 | }
10 |
11 | has_support <- function(path = ".") {
12 | file_exists(path(path, 'SUPPORT.md')) ||
13 | file_exists(path(path, '.github', 'SUPPORT.md'))
14 | }
15 |
16 | data_home_sidebar_community <- function (pkg){
17 |
18 | pkg <- as_pkgdown(pkg)
19 |
20 | links <- NULL
21 |
22 | if (has_contributing(pkg$src_path)) {
23 | links <- c(links, a(tr_("Contributing guide"), "CONTRIBUTING.html"))
24 | }
25 |
26 | if (has_coc(pkg$src_path)) {
27 | links <- c(links, a(tr_("Code of conduct"), "CODE_OF_CONDUCT.html"))
28 | }
29 |
30 | if (has_support(pkg$src_path)) {
31 | links <- c(links, a(tr_("Getting help"), "SUPPORT.html"))
32 | }
33 |
34 | if (is.null(links)) {
35 | return("")
36 | }
37 |
38 | sidebar_section(tr_("Community"), links)
39 |
40 | }
41 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/tweak-tabset.md:
--------------------------------------------------------------------------------
1 | # sections with class .tabset are converted to tabsets
2 |
3 |
4 |
Tabset
6 |
7 |
8 |
9 | Tab 1 Tab 2
12 |
13 |
14 |
15 |
Contents 1
16 |
17 |
18 |
19 |
Contents 2
20 |
21 |
22 |
2 |
3 |
8 |
9 |
10 | {{#description}}
11 | {{#contents}}
12 | {{{.}}}
13 | {{/contents}}
14 | {{/description}}
15 |
16 |
17 | {{#usage}}
18 |
{{#contents}}
19 | {{{.}}}
20 | {{/contents}}
21 | {{/usage}}
22 |
23 | {{#sections}}
24 |
25 |
{{{title}}}
26 | {{#contents}}
27 | {{{.}}}
28 | {{/contents}}
29 |
30 | {{/sections}}
31 |
32 | {{#examples}}
33 |
34 |
Examples
35 | {{{.}}}
36 |
37 | {{/examples}}
38 |
39 |
44 |
2 |
3 |
7 |
8 |
9 |
{{#translate}}{{authors}}{{/translate}}
10 | {{{before}}}
11 |
19 | {{{after}}}
20 |
23 |
{{#translate}}{{citation}}{{/translate}}
24 |
{{#source}}{{{.}}} {{/source}}
25 |
26 | {{#citations}}
27 | {{{html}}}
28 |
{{{bibtex}}}
29 | {{/citations}}
30 |
32 |
33 |
34 |
35 | {{#translate}}{{on_this_page}}{{/translate}}
36 |
37 |
38 |
", text, " "))
3 | }
4 |
5 | link_url <- function(text, href) {
6 | if (!is.null(href)) {
7 | paste0("", text, " ")
8 | }
9 | }
10 |
11 | linkify <- function(text) {
12 | text <- escape_html(text)
13 | text <- gsub(
14 | "<doi:([^&]+)>", # DOIs with < > & are not supported
15 | "<doi:\\1 >",
16 | text, ignore.case = TRUE
17 | )
18 | text <- gsub(
19 | "<arXiv:([^&]+)>",
20 | "<arXiv:\\1 >",
21 | text, ignore.case = TRUE
22 | )
23 | text <- gsub(
24 | "<((http|ftp)[^&]+)>", # URIs with & are not supported
25 | "<\\1 >",
26 | text
27 | )
28 | text
29 | }
30 |
31 | dont_index <- function(x) {
32 | paste0("", x, "
")
33 | }
34 |
35 | escape_html <- function(x) {
36 | x <- gsub("&", "&", x)
37 | x <- gsub("<", "<", x)
38 | x <- gsub(">", ">", x)
39 | # x <- gsub("'", "'", x)
40 | # x <- gsub("\"", """, x)
41 | x
42 | }
43 |
44 | strip_html_tags <- function(x) gsub("<.*?>", "", x)
45 |
--------------------------------------------------------------------------------
/man/build_search.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/build-search-docs.R
3 | \name{build_search}
4 | \alias{build_search}
5 | \title{Build search index}
6 | \usage{
7 | build_search(pkg = ".", override = list())
8 | }
9 | \arguments{
10 | \item{pkg}{Path to package.}
11 |
12 | \item{override}{An optional named list used to temporarily override
13 | values in \verb{_pkgdown.yml}}
14 | }
15 | \description{
16 | Build a JSON file encompassing all HTML pages, for use by the search script.
17 | }
18 | \section{YAML config}{
19 |
20 | You can exclude some paths from the search index.
21 | Below we exclude the changelog from the search index.
22 |
23 | \if{html}{\out{}}\preformatted{search:
24 | exclude: ['news/index.html']
25 | }\if{html}{\out{
}}
26 | }
27 |
28 | \section{Debugging and local testing}{
29 |
30 |
31 | Locally (as opposed to on GitHub Pages or Netlify for instance),
32 | search won't work if you simply use pkgdown preview of the static files.
33 | You can use \code{servr::httw("docs")} instead.
34 |
35 | If search is not working, run \code{pkgdown::pkgdown_sitrep()} to eliminate
36 | common issues such as the absence of URL in the pkgdown configuration file
37 | of your package.
38 | }
39 |
40 |
--------------------------------------------------------------------------------
/man/rmd-fragments/footer-configuration.Rmd:
--------------------------------------------------------------------------------
1 | You can customise the footer with the `footer` field.
2 | It's made up of two pieces: `structure`, which defines the overall layout, and `components`, which defines what each piece looks like.
3 | This organisation makes it easy to mix and match the pkgdown defaults with your own customisations.
4 |
5 | This is the default structure:
6 |
7 | ``` yaml
8 | footer:
9 | structure:
10 | left: developed_by
11 | right: built_with
12 | ```
13 |
14 | Which uses two of the three built-in components:
15 |
16 | - `developed_by`, a sentence describing the main authors of the package. (See `?build_home` if you want to tweak *which* authors appear in the footer.)
17 | - `built_with`, a sentence advertising pkgdown.
18 | - `package`, the name of the package.
19 |
20 | You can override these defaults with the `footer` field.
21 | The example below puts the authors' information on the right along with a legal disclaimer, and puts the pkgdown link on the left.
22 |
23 | ``` yaml
24 | footer:
25 | structure:
26 | left: pkgdown
27 | right: [authors, legal]
28 | components:
29 | legal: Provided without **any warranty**.
30 | ```
31 |
32 | Each side is pasted into a single string (separated by `" "`) and then converted from markdown to HTML.
33 |
--------------------------------------------------------------------------------
/man/pkgdown-package.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/pkgdown.R
3 | \docType{package}
4 | \name{pkgdown-package}
5 | \alias{pkgdown}
6 | \alias{pkgdown-package}
7 | \title{pkgdown: Make Static HTML Documentation for a Package}
8 | \description{
9 | \if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}}
10 |
11 | Generate an attractive and useful website from a source package. 'pkgdown' converts your documentation, vignettes, 'README', and more to 'HTML' making it easy to share information about your package online.
12 | }
13 | \seealso{
14 | Useful links:
15 | \itemize{
16 | \item \url{https://pkgdown.r-lib.org}
17 | \item \url{https://github.com/r-lib/pkgdown}
18 | \item Report bugs at \url{https://github.com/r-lib/pkgdown/issues}
19 | }
20 |
21 | }
22 | \author{
23 | \strong{Maintainer}: Hadley Wickham \email{hadley@rstudio.com} (\href{https://orcid.org/0000-0003-4757-117X}{ORCID})
24 |
25 | Authors:
26 | \itemize{
27 | \item Jay Hesselberth (\href{https://orcid.org/0000-0002-6299-179X}{ORCID})
28 | \item Maëlle Salmon (\href{https://orcid.org/0000-0002-2815-0399}{ORCID})
29 | }
30 |
31 | Other contributors:
32 | \itemize{
33 | \item RStudio [copyright holder, funder]
34 | }
35 |
36 | }
37 | \keyword{internal}
38 |
--------------------------------------------------------------------------------
/R/pkgdown_print.R:
--------------------------------------------------------------------------------
1 | #' Print object in pkgdown output
2 | #'
3 | #' This lets package authors control how objects are printed just for
4 | #' pkgdown examples. The default is to call [print()] apart from htmlwidgets
5 | #' where the object is returned as is (with sizes tweaked).
6 | #'
7 | #' @param x Object to display
8 | #' @param visible Whether it is visible or not
9 | #' @return Either a character vector representing printed output (which
10 | #' will be escaped for HTML as necessary) or literal HTML produced
11 | #' by the htmltools or htmlwidgets packages.
12 | #' @keywords internal
13 | #' @export
14 | pkgdown_print <- function(x, visible = TRUE) {
15 | UseMethod("pkgdown_print")
16 | }
17 |
18 | #' @export
19 | pkgdown_print.default <- function(x, visible = TRUE) {
20 | if (!visible) {
21 | return(invisible())
22 | }
23 |
24 | # inlined from htmltools::is.browsable()
25 | if (isTRUE(attr(x, "browsable_html", exact = TRUE))) {
26 | x
27 | } else {
28 | print(x)
29 | }
30 | }
31 |
32 | #' @export
33 | pkgdown_print.htmlwidget <- function(x, visible = TRUE) {
34 | if (!visible) {
35 | return(invisible())
36 | }
37 |
38 | settings <- fig_settings()
39 | x$width <- x$width %||% (settings$fig.width * settings$dpi)
40 | x$height <- x$height %||% (settings$fig.height * settings$dpi)
41 | x
42 | }
43 |
--------------------------------------------------------------------------------
/inst/highlight-styles/haddock.scss:
--------------------------------------------------------------------------------
1 | pre code span.al /* Alert */ {color:#ff0000}
2 | pre code span.an /* Annotation */ {color:#008000}
3 | pre code span.at /* Attribute */ {}
4 | pre code span.bu /* BuiltIn */ {}
5 | pre code span.cf /* ControlFlow */ {color:#0000ff}
6 | pre code span.ch /* Char */ {color:#008080}
7 | pre code span.cn /* Constant */ {}
8 | pre code span.co /* Comment */ {color:#008000}
9 | pre code span.cv /* CommentVar */ {color:#008000}
10 | pre code span.do /* Documentation */ {color:#008000}
11 | pre code span.er /* Error */ {color:#ff0000; font-weight: bold}
12 | pre code span.ex /* Extension */ {}
13 | pre code span.im /* Import */ {}
14 | pre code span.in /* Information */ {color:#008000}
15 | pre code span.kw /* Keyword */ {color:#0000ff}
16 | pre code span.op /* Operator */ {}
17 | pre code span.ot /* Other */ {color:#ff4000}
18 | pre code span.pp /* Preprocessor */ {color:#ff4000}
19 | pre code span.sc /* SpecialChar */ {color:#008080}
20 | pre code span.ss /* SpecialString */ {color:#008080}
21 | pre code span.st /* String */ {color:#008080}
22 | pre code span.va /* Variable */ {}
23 | pre code span.vs /* VerbatimString */ {color:#008080}
24 | pre code span.wa /* Warning */ {color:#008000; font-weight: bold}
25 |
--------------------------------------------------------------------------------
/inst/BS5/templates/content-reference-topic.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
9 |
10 |
11 | {{#description}}
12 | {{#contents}}
13 | {{{.}}}
14 | {{/contents}}
15 | {{/description}}
16 |
17 |
18 | {{#usage}}
19 |
20 |
{{{title}}}
21 | {{#contents}}
22 | {{{.}}}
23 | {{/contents}}
24 |
25 | {{/usage}}
26 |
27 | {{#sections}}
28 |
29 |
{{{title}}}
30 | {{#contents}}
31 | {{{.}}}
32 | {{/contents}}
33 |
34 | {{/sections}}
35 |
36 | {{#examples}}
37 |
38 |
{{#translate}}{{examples}}{{/translate}}
39 | {{{.}}}
40 |
41 | {{/examples}}
42 |
43 |
44 |
45 | {{#translate}}{{on_this_page}}{{/translate}}
46 |
47 |
48 |
some text about data"),
4 | "some text about data"
5 | )
6 | })
7 |
8 | # links and references in the package description -------------------------
9 |
10 | test_that("references in angle brackets are converted to HTML", {
11 | ## URL
12 | expect_identical(
13 | linkify("see ."),
14 | "see <https://CRAN.R-project.org/view=SpatioTemporal >."
15 | )
16 | ## DOI
17 | expect_identical(
18 | linkify("M & H (2017) "),
19 | "M & H (2017) <doi:10.1093/biostatistics/kxw051 >"
20 | )
21 | ## arXiv
22 | expect_identical(
23 | linkify("see ."),
24 | "see <arXiv:1802.03967 >."
25 | )
26 | ## unsupported formats are left alone (just escaping special characters)
27 | unsupported <- c(
28 | "3.0.CO;2-P>",
29 | ""
30 | )
31 | expect_identical(linkify(unsupported), escape_html(unsupported))
32 | })
33 |
--------------------------------------------------------------------------------
/man/render_page.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/render.R
3 | \name{render_page}
4 | \alias{render_page}
5 | \alias{data_template}
6 | \title{Render page with template}
7 | \usage{
8 | render_page(pkg = ".", name, data, path, depth = NULL, quiet = FALSE)
9 |
10 | data_template(pkg = ".", depth = 0L)
11 | }
12 | \arguments{
13 | \item{pkg}{Path to package to document.}
14 |
15 | \item{name}{Name of the template (e.g. "home", "vignette", "news")}
16 |
17 | \item{data}{Data for the template.
18 |
19 | This is automatically supplemented with three lists:
20 | \itemize{
21 | \item \code{site}: \code{title} and path to \code{root}.
22 | \item \code{yaml}: the \code{template} key from \verb{_pkgdown.yml}.
23 | \item \code{package}: package metadata including \code{name} and\code{version}.
24 | }
25 |
26 | See the full contents by running \code{\link[=data_template]{data_template()}}.}
27 |
28 | \item{path}{Location to create file; relative to destination directory.}
29 |
30 | \item{depth}{Depth of path relative to base directory.}
31 |
32 | \item{quiet}{If \code{quiet}, will suppress output messages}
33 | }
34 | \description{
35 | Each page is composed of four templates: "head", "header", "content", and
36 | "footer". Each of these templates is rendered using the \code{data}, and
37 | then assembled into an overall page using the "layout" template.
38 | }
39 |
--------------------------------------------------------------------------------
/tests/testthat/test-build-tutorials.R:
--------------------------------------------------------------------------------
1 | test_that("can autodetect tutorials", {
2 | # Can't embed in package because path is too long and gives R CMD check NOTE
3 | pkg <- test_path("assets/tutorials")
4 | dcf_src <- path(pkg, "vignettes/tutorials/test-1/")
5 | dcf_dst <- path(dcf_src, "rsconnect/documents/test-1.Rmd/shinyapps.io/hadley")
6 | dir_create(dcf_dst)
7 | file_copy(path(dcf_src, "tutorial-test-1.dcf"), dcf_dst, overwrite = TRUE)
8 | withr::defer(dir_delete(path(pkg, "vignettes/tutorials/test-1/rsconnect")))
9 |
10 | out <- package_tutorials(pkg)
11 | expect_equal(out$name, "test-1")
12 | expect_equal(out$file_out, "tutorials/test-1.html")
13 | expect_equal(out$url, "https://hadley.shinyapps.io/tutorial-test-1/")
14 |
15 | # and aren't included in vignettes
16 | out <- package_vignettes(test_path("assets/tutorials"))
17 | expect_equal(nrow(out), 0)
18 | })
19 |
20 | test_that("can manually supply tutorials", {
21 | meta <- list(
22 | tutorials = list(
23 | list(name = "1-name", title = "1-title", url = "1-url"),
24 | list(name = "2-name", title = "2-title", url = "2-url")
25 | )
26 | )
27 |
28 | out <- package_tutorials(test_path("assets/tutorials"), meta)
29 | expect_equal(out$name, c("1-name", "2-name"))
30 | expect_equal(out$file_out, c("tutorials/1-name.html", "tutorials/2-name.html"))
31 | expect_equal(out$url, c("1-url", "2-url"))
32 | })
33 |
--------------------------------------------------------------------------------
/R/build-home-md.R:
--------------------------------------------------------------------------------
1 | build_home_md <- function(pkg) {
2 |
3 | mds <- dir_ls(pkg$src_path, glob = "*.md")
4 |
5 | # Also looks in .github, if it exists
6 | github_path <- path(pkg$src_path, ".github")
7 | if (dir_exists(github_path)) {
8 | mds <- c(mds, dir_ls(github_path, glob = "*.md"))
9 | }
10 |
11 | # Remove files handled elsewhere
12 | handled <- c("README.md", "LICENSE.md", "LICENCE.md", "NEWS.md", "cran-comments.md")
13 | mds <- mds[!path_file(mds) %in% handled]
14 |
15 | # Do not build 404 page if in-dev
16 | if (pkg$development$in_dev) {
17 | mds <- mds[fs::path_file(mds) != "404.md"]
18 | }
19 |
20 | lapply(mds, render_md, pkg = pkg)
21 | invisible()
22 | }
23 |
24 | render_md <- function(pkg, filename) {
25 | cat_line("Reading ", src_path(path_rel(filename, pkg$src_path)))
26 |
27 | body <- markdown_body(filename, strip_header = TRUE)
28 | path <- path_ext_set(basename(filename), "html")
29 |
30 | render_page(pkg, "title-body",
31 | data = list(
32 | pagetitle = attr(body, "title"),
33 | body = body,
34 | filename = filename,
35 | source = repo_source(pkg, fs::path_rel(filename, pkg$src_path))
36 | ),
37 | path = path
38 | )
39 |
40 | if (path == "404.html") {
41 | update_html(path(pkg$dst_path, path), tweak_link_absolute, pkg = pkg)
42 | }
43 | check_missing_images(pkg, filename, path)
44 |
45 | invisible()
46 | }
47 |
--------------------------------------------------------------------------------
/R/build-footer.R:
--------------------------------------------------------------------------------
1 | data_footer <- function(pkg = ".") {
2 | pkg <- as_pkgdown(pkg)
3 |
4 | meta_footer <- pkg$meta$footer
5 | components <- modify_list(footnote_components(pkg), meta_footer$components)
6 | structure <- modify_list(footnote_structure(), meta_footer$structure)
7 |
8 | left <- markdown_text_block(paste0(components[structure$left], collapse = " "))
9 | right <- markdown_text_block(paste0(components[structure$right], collapse = " "))
10 |
11 | list(left = left, right = right)
12 | }
13 |
14 | footnote_components <- function(pkg = ".") {
15 | pkg <- as_pkgdown(pkg)
16 |
17 | # Authors
18 | roles <- pkg$meta$authors$footer$roles %||% default_roles()
19 | authors <- data_authors(pkg, roles = roles)$main %>%
20 | purrr::map_chr("name") %>%
21 | paste(collapse = ", ")
22 |
23 | prefix <- pkg$meta$authors$footer$text %||% tr_("Developed by")
24 | developed_by <- paste0(trimws(prefix), " ", authors, ".")
25 |
26 | # pkgdown
27 | built_with <- sprintf(
28 | tr_('Site built with pkgdown %s.'),
29 | "https://pkgdown.r-lib.org/",
30 | utils::packageVersion("pkgdown")
31 | )
32 |
33 | print_yaml(list(
34 | developed_by = developed_by,
35 | built_with = built_with,
36 | package = pkg[["package"]]
37 | ))
38 | }
39 |
40 | footnote_structure <- function() {
41 | print_yaml(list(
42 | left = "developed_by",
43 | right = "built_with"
44 | ))
45 | }
46 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/render.md:
--------------------------------------------------------------------------------
1 | # check_bootswatch_theme() works
2 |
3 | Can't find Bootswatch theme 'paper' (template.bootswatch) for Bootstrap version '4' (template.bootstrap).
4 |
5 | # capture data_template()
6 |
7 | package:
8 | name: testpackage
9 | version: 1.0.0
10 | logo:
11 | src: ~
12 | site:
13 | root: ''
14 | title: testpackage
15 | year:
16 | lang: en
17 | translate:
18 | skip: Skip to contents
19 | toggle_nav: Toggle navigation
20 | search_for: Search for
21 | on_this_page: On this page
22 | source: Source
23 | abstract: Abstract
24 | authors: Authors
25 | version: Version
26 | examples: Examples
27 | citation: Citation
28 | has_favicons: no
29 | opengraph: []
30 | extra:
31 | css: ~
32 | js: ~
33 | includes: []
34 | yaml:
35 | .present: yes
36 | development:
37 | destination: dev
38 | mode: default
39 | version_label: default
40 | in_dev: no
41 | version_tooltip: ''
42 | navbar:
43 | type: default
44 | left: |-
45 |
46 | Reference
47 |
48 | right: ''
49 | footer:
50 | left: Developed by Hadley Wickham, RStudio.
51 | right: Site built with pkgdown {version}.
52 |
53 |
54 |
--------------------------------------------------------------------------------
/tests/testthat/test-highlight.R:
--------------------------------------------------------------------------------
1 | test_that("highlight_examples captures depencies", {
2 | withr::defer(unlink(test_path("Rplot001.png")))
3 |
4 | dummy_dep <- htmltools::htmlDependency("dummy", "1.0.0", "dummy.js")
5 | widget <- htmlwidgets::createWidget("test", list(), dependencies = dummy_dep)
6 | out <- highlight_examples("widget", env = environment())
7 |
8 | # htmlwidgets always get dependency on htmlwidgets.js
9 | expect_equal(attr(out, "dependencies")[-1], list(dummy_dep))
10 | })
11 |
12 | test_that("highlight_text & highlight_examples include sourceCode div", {
13 | withr::defer(unlink(test_path("Rplot001.png")))
14 |
15 | html <- xml2::read_html(highlight_examples("a + a", "x"))
16 | expect_equal(xpath_attr(html, "./body/div", "class"), "sourceCode")
17 |
18 | html <- xml2::read_html(highlight_text("a + a"))
19 | expect_equal(xpath_attr(html, "./body/div", "class"), "sourceCode")
20 | })
21 |
22 | test_that("pre() can produce needed range of outputs", {
23 | expect_snapshot({
24 | cat(pre("x"))
25 | cat(pre("x", r_code = TRUE))
26 | })
27 | })
28 |
29 | test_that("tweak_highlight_other() renders generic code blocks for roxygen2 >= 7.2.0", {
30 | div <- xml2::read_html('') %>%
31 | xml2::xml_find_first("//div")
32 | tweak_highlight_other(div)
33 | expect_equal(
34 | xml2::xml_text(xml2::xml_find_first(div, "pre/code")),
35 | "1+1"
36 | )
37 | })
38 |
--------------------------------------------------------------------------------
/tests/testthat/test-rmarkdown.R:
--------------------------------------------------------------------------------
1 | test_that("render_rmarkdown copies image files in subdirectories", {
2 | skip_if_no_pandoc()
3 | tmp <- dir_create(file_temp())
4 | pkg <- list(src_path = test_path("."), dst_path = tmp, bs_version = 3)
5 |
6 | expect_output(
7 | render_rmarkdown(pkg, "assets/vignette-with-img.Rmd", "test.html")
8 | )
9 | expect_equal(
10 | as.character(path_rel(dir_ls(tmp, type = "file", recurse = TRUE), tmp)),
11 | c("open-graph/logo.png", "test.html")
12 | )
13 | })
14 |
15 | test_that("render_rmarkdown yields useful error", {
16 | skip_on_cran() # fragile due to pandoc dependency
17 | skip_if_no_pandoc("2.18")
18 |
19 | tmp <- dir_create(file_temp())
20 | pkg <- list(src_path = test_path("."), dst_path = tmp, bs_version = 3)
21 |
22 | expect_snapshot(error = TRUE, {
23 | render_rmarkdown(pkg, "assets/pandoc-fail.Rmd", "test.html",
24 | output_format = rmarkdown::html_document(pandoc_args = "--fail-if-warnings"))
25 | })
26 | })
27 |
28 | test_that("render_rmarkdown styles ANSI escapes", {
29 | skip_if_no_pandoc()
30 | tmp <- dir_create(file_temp())
31 | pkg <- list(src_path = test_path("."), dst_path = tmp, bs_version = 5)
32 |
33 | expect_output({
34 | path <- render_rmarkdown(pkg,
35 | input = "assets/vignette-with-crayon.Rmd",
36 | output = "test.html"
37 | )
38 | })
39 | html <- xml2::read_html(path)
40 | expect_snapshot_output(xpath_xml(html, ".//code//span[@class='co']"))
41 | })
42 |
--------------------------------------------------------------------------------
/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Code of Conduct
2 |
3 | As contributors and maintainers of this project, we pledge to respect all people who
4 | contribute through reporting issues, posting feature requests, updating documentation,
5 | submitting pull requests or patches, and other activities.
6 |
7 | We are committed to making participation in this project a harassment-free experience for
8 | everyone, regardless of level of experience, gender, gender identity and expression,
9 | sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
10 |
11 | Examples of unacceptable behavior by participants include the use of sexual language or
12 | imagery, derogatory comments or personal attacks, trolling, public or private harassment,
13 | insults, or other unprofessional conduct.
14 |
15 | Project maintainers have the right and responsibility to remove, edit, or reject comments,
16 | commits, code, wiki edits, issues, and other contributions that are not aligned to this
17 | Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
18 | from the project team.
19 |
20 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
21 | opening an issue or contacting one or more of the project maintainers.
22 |
23 | This Code of Conduct is adapted from the Contributor Covenant
24 | (http://contributor-covenant.org), version 1.0.0, available at
25 | http://contributor-covenant.org/version/1/0/0/
26 |
--------------------------------------------------------------------------------
/R/build-home.R:
--------------------------------------------------------------------------------
1 | #' Build home section
2 | #'
3 | #' @description
4 | #' `build_home()` function generates pages at the top-level of the site
5 | #' including:
6 | #'
7 | #' * The home page
8 | #' * HTML files from any `.md` files in `./` or `.github/`.
9 | #' * The authors page (from `DESCRIPTION`)
10 | #' * The citation page (from `inst/CITATION`, if present).
11 | #' * The license page
12 | #' * A default 404 page if `.github/404.md` is not found.
13 | #'
14 | #' `build_home_index()` rebuilds just the index page; it's useful for rapidly
15 | #' iterating when experimenting with site styles.
16 | #'
17 | #' ```{r child="man/rmd-fragments/home-configuration.Rmd"}
18 | #' ```
19 | #' ```{r child="man/rmd-fragments/authors-configuration.Rmd"}
20 | #' ```
21 | #'
22 | #' @section Sidebar:
23 | #' ```{r child="man/rmd-fragments/sidebar-configuration.Rmd"}
24 | #' ```
25 | #'
26 | #' @inheritParams build_articles
27 | #' @export
28 | build_home <- function(pkg = ".",
29 | override = list(),
30 | preview = NA,
31 | quiet = TRUE) {
32 |
33 | pkg <- section_init(pkg, depth = 0L, override = override)
34 | rule("Building home")
35 | dir_create(pkg$dst_path)
36 |
37 | build_citation_authors(pkg)
38 |
39 | build_home_md(pkg)
40 | build_home_license(pkg)
41 | build_home_index(pkg, quiet = quiet)
42 |
43 | if (!pkg$development$in_dev) {
44 | build_404(pkg)
45 | }
46 |
47 |
48 | preview_site(pkg, "/", preview = preview)
49 | }
50 |
--------------------------------------------------------------------------------
/tests/testthat/test-render.R:
--------------------------------------------------------------------------------
1 | test_that("check_bootswatch_theme() works", {
2 | expect_equal(check_bootswatch_theme("_default", 4, list()), NULL)
3 | expect_equal(check_bootswatch_theme("lux", 4, list()), "lux")
4 | expect_snapshot_error(check_bootswatch_theme("paper", 4, list()))
5 | })
6 |
7 | test_that("capture data_template()", {
8 | pkg <- as_pkgdown(test_path("assets/site-empty"))
9 | data <- data_template(pkg)
10 | data$year <- ""
11 | data$footer$right <- gsub(packageVersion("pkgdown"), "{version}", data$footer$right, fixed = TRUE)
12 | expect_snapshot_output(data)
13 | })
14 |
15 | test_that("can include text in header, before body, and after body", {
16 | pkg <- local_pkgdown_site(test_path("assets/site-empty"), '
17 | template:
18 | includes:
19 | in_header: in header
20 | before_body: before body
21 | after_body: after body
22 | ')
23 |
24 | expect_named(
25 | data_template(pkg)$includes,
26 | c("in_header", "before_body", "after_body")
27 | )
28 |
29 | pkg$bs_version <- 3
30 | html <- render_page_html(pkg, "title-body")
31 | expect_equal(
32 | xpath_text(html, ".//test"),
33 | c("in header", "before body", "after body")
34 | )
35 |
36 | pkg$bs_version <- 5
37 | expect_output(init_site(pkg))
38 | html <- render_page_html(pkg, "title-body")
39 | expect_equal(
40 | xpath_text(html, ".//test"),
41 | c("in header", "before body", "after body")
42 | )
43 | })
44 |
--------------------------------------------------------------------------------
/tests/testthat/test-build-redirects.R:
--------------------------------------------------------------------------------
1 | test_that("build_redirect() works", {
2 | pkg <- list(
3 | src_path = withr::local_tempdir(),
4 | dst_path = withr::local_tempdir(),
5 | meta = list(url = "https://example.com"),
6 | prefix = "",
7 | bs_version = 5
8 | )
9 | pkg <- structure(pkg, class = "pkgdown")
10 | build_redirect(c("old.html", "new.html#section"), 1, pkg = pkg)
11 |
12 | html <- xml2::read_html(path(pkg$dst_path, "old.html"))
13 | expect_equal(
14 | xpath_attr(html, "//link", "href"),
15 | "https://example.com/new.html#section"
16 | )
17 | })
18 |
19 | test_that("build_redirect() errors if one entry is not right.", {
20 | pkg <- list(
21 | src_path = withr::local_tempdir(),
22 | dst_path = withr::local_tempdir(),
23 | meta = list(url = "https://example.com"),
24 | prefix = "",
25 | bs_version = 5
26 | )
27 | pkg <- structure(pkg, class = "pkgdown")
28 | expect_snapshot_error(build_redirect(c("old.html"), 5, pkg = pkg))
29 | })
30 |
31 | test_that("article_redirects() creates redirects for vignettes in vignettes/articles", {
32 | dir <- withr::local_tempdir()
33 | dir_create(path(dir, "vignettes", "articles"))
34 | file_create(path(dir, "vignettes", "articles", "test.Rmd"))
35 |
36 | pkg <- list(
37 | meta = list(url = "http://foo.com"),
38 | vignettes = package_vignettes(dir)
39 | )
40 |
41 | expect_equal(
42 | article_redirects(pkg),
43 | list(c("articles/articles/test.html", "articles/test.html"))
44 | )
45 | })
46 |
--------------------------------------------------------------------------------
/R/pkgdown.R:
--------------------------------------------------------------------------------
1 | #' @importFrom magrittr %>%
2 | #' @importFrom utils installed.packages
3 | #' @import rlang
4 | #' @import fs
5 | #' @keywords internal
6 | "_PACKAGE"
7 |
8 | release_bullets <- function() {
9 | c(
10 | "Check that 'test/widget.html' responds to mouse clicks"
11 | )
12 | }
13 |
14 | #' Determine if code is executed by pkgdown
15 | #'
16 | #' This is occasionally useful when you need different behaviour by
17 | #' pkgdown and regular documentation.
18 | #'
19 | #' @export
20 | #' @examples
21 | #' in_pkgdown()
22 | in_pkgdown <- function() {
23 | identical(Sys.getenv("IN_PKGDOWN"), "true")
24 | }
25 |
26 | local_envvar_pkgdown <- function(pkg, scope = parent.frame()) {
27 | withr::local_envvar(
28 | IN_PKGDOWN = "true",
29 | LANGUAGE = pkg$lang,
30 | .local_envir = scope
31 | )
32 | }
33 |
34 | local_pkgdown_site <- function(path = NULL, meta = NULL, env = parent.frame()) {
35 | if (is.null(path)) {
36 | path <- withr::local_tempdir(.local_envir = env)
37 | desc <- desc::desc("!new")
38 | desc$set("Package", "testpackage")
39 | desc$set("Title", "A test package")
40 | desc$write(file = file.path(path, "DESCRIPTION"))
41 | }
42 |
43 | if (is.character(meta)) {
44 | meta <- yaml::yaml.load(meta)
45 | } else if (is.null(meta)) {
46 | meta <- list()
47 | }
48 | pkg <- as_pkgdown(path, meta)
49 | pkg$dst_path <- withr::local_tempdir(.local_envir = env)
50 |
51 | withr::defer(unlink(pkg$dst_path, recursive = TRUE), envir = env)
52 |
53 | pkg
54 | }
55 |
--------------------------------------------------------------------------------
/man/build_site_github_pages.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/build-github.R
3 | \name{build_site_github_pages}
4 | \alias{build_site_github_pages}
5 | \title{Build site for GitHub pages}
6 | \usage{
7 | build_site_github_pages(
8 | pkg = ".",
9 | ...,
10 | dest_dir = "docs",
11 | clean = TRUE,
12 | install = FALSE,
13 | new_process = FALSE
14 | )
15 | }
16 | \arguments{
17 | \item{pkg}{Path to package.}
18 |
19 | \item{...}{Additional arguments passed to \code{\link[=build_site]{build_site()}}.}
20 |
21 | \item{dest_dir}{Directory to build site in.}
22 |
23 | \item{clean}{Clean all files from old site.}
24 |
25 | \item{install}{If \code{TRUE}, will install the package in a temporary library
26 | so it is available for vignettes.}
27 |
28 | \item{new_process}{If \code{TRUE}, will run \code{build_site()} in a separate process.
29 | This enhances reproducibility by ensuring nothing that you have loaded
30 | in the current process affects the build process.}
31 | }
32 | \description{
33 | Designed to be run as part of automated workflows for deploying
34 | to GitHub pages. It cleans out the old site, builds the site into \code{dest_dir}
35 | adds a \code{.nojekyll} file to suppress rendering by Jekyll, and adds a \code{CNAME}
36 | file if needed.
37 |
38 | It is designed to be run in CI, so by default it:
39 | \itemize{
40 | \item Clean out the old site.
41 | \item Does not install the package.
42 | \item Runs \code{\link[=build_site]{build_site()}} in process.
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/man/test-dont.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/test.R
3 | \name{test-dont}
4 | \alias{test-dont}
5 | \title{Test case: don't}
6 | \description{
7 | Test case: don't
8 | }
9 | \examples{
10 | \dontrun{
11 | stop("This is an error!", call. = FALSE)
12 | }
13 |
14 | # Inline \donttest is silently ommitted
15 | \donttest{message("Hi!")}
16 |
17 | # Block \donttest indicated with comments
18 | \donttest{
19 | # This is a comment
20 | 1 + 3
21 | }
22 |
23 | # And works even when not at the top level
24 | if (TRUE) {
25 | \donttest{
26 | 1 + 2
27 | }
28 | }
29 |
30 | answer <- 1
31 | \dontshow{
32 | answer <- 42
33 | }
34 | answer # should be 42
35 |
36 | # To hide the \dontshow part, for conditional examples
37 | \dontshow{if (FALSE) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
38 | answer <- 43
39 | \dontshow{\}) # examplesIf}
40 | answer # should be still 42
41 |
42 | # But this one runs, and the condition is hidden
43 | \dontshow{if (TRUE) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
44 | answer <- 43
45 | \dontshow{\}) # examplesIf}
46 | answer
47 | }
48 | \seealso{
49 | Other tests:
50 | \code{\link{index}},
51 | \code{\link{test-crayon}},
52 | \code{\link{test-figures}},
53 | \code{\link{test-links}},
54 | \code{\link{test-lists}},
55 | \code{\link{test-long-lines}},
56 | \code{\link{test-output-styles}},
57 | \code{\link{test-params}},
58 | \code{\link{test-sexpr-title}},
59 | \code{\link{test-verbatim}}
60 | }
61 | \concept{tests}
62 | \keyword{internal}
63 |
--------------------------------------------------------------------------------
/man/test-verbatim.Rd:
--------------------------------------------------------------------------------
1 | % Generated by roxygen2: do not edit by hand
2 | % Please edit documentation in R/test.R
3 | \name{test-verbatim}
4 | \alias{test-verbatim}
5 | \title{Test case: preformatted blocks & syntax highlighting}
6 | \description{
7 | Manual test cases for various ways of embedding code in sections.
8 | All code blocks should have copy and paste button.
9 | }
10 | \section{Should be highlighted}{
11 | Valid R code in \verb{\preformatted{}}:
12 |
13 | \if{html}{\out{}}\preformatted{mean(a + 1)
14 | }\if{html}{\out{
}}
15 |
16 | R code in \code{R} block:
17 |
18 | \if{html}{\out{}}\preformatted{mean(a + 1)
19 | }\if{html}{\out{
}}
20 |
21 | R code in \code{r} block:
22 |
23 | \if{html}{\out{}}\preformatted{mean(a + 1)
24 | }\if{html}{\out{
}}
25 |
26 | Yaml
27 |
28 | \if{html}{\out{}}\preformatted{yaml: [a, 1]
29 | }\if{html}{\out{
}}
30 | }
31 |
32 | \section{Shouldn't be highlighted}{
33 | Non-R code in \verb{\preformatted{}}
34 |
35 | \if{html}{\out{}}\preformatted{yaml: [a, b, c]
36 | }\if{html}{\out{
}}
37 | }
38 |
39 | \seealso{
40 | Other tests:
41 | \code{\link{index}},
42 | \code{\link{test-crayon}},
43 | \code{\link{test-dont}},
44 | \code{\link{test-figures}},
45 | \code{\link{test-links}},
46 | \code{\link{test-lists}},
47 | \code{\link{test-long-lines}},
48 | \code{\link{test-output-styles}},
49 | \code{\link{test-params}},
50 | \code{\link{test-sexpr-title}}
51 | }
52 | \concept{tests}
53 | \keyword{internal}
54 |
--------------------------------------------------------------------------------
/tests/testthat/test-init.R:
--------------------------------------------------------------------------------
1 | test_that("extra.css and extra.js copied and linked", {
2 | pkg <- local_pkgdown_site(test_path("assets/init-extra-2"))
3 | expect_output(init_site(pkg))
4 |
5 | expect_true(file_exists(path(pkg$dst_path, "extra.css")))
6 | expect_true(file_exists(path(pkg$dst_path, "extra.js")))
7 |
8 | skip_if_no_pandoc()
9 | # Now check they actually get used .
10 | expect_output(build_home(pkg))
11 |
12 | html <- xml2::read_html(path(pkg$dst_path, "index.html"))
13 | paths <- xpath_attr(html, ".//link", "href")
14 |
15 | expect_true("extra.css" %in% paths)
16 | })
17 |
18 | test_that("single extra.css correctly copied", {
19 | pkg <- local_pkgdown_site(test_path("assets/init-extra-1"))
20 | expect_output(init_site(pkg))
21 |
22 | expect_true(file_exists(path(pkg$dst_path, "extra.css")))
23 | })
24 |
25 | test_that("asset subdirectories are copied", {
26 | pkg <- local_pkgdown_site(test_path("assets/init-asset-subdirs"))
27 | expect_output(init_site(pkg))
28 |
29 | expect_true(file_exists(path(pkg$dst_path, "subdir1", "file1.txt")))
30 | expect_true(file_exists(path(pkg$dst_path, "subdir1", "subdir2", "file2.txt")))
31 | })
32 |
33 | test_that("site meta doesn't break unexpectedly", {
34 | pkgdown <- as_pkgdown(test_path("assets/reference"))
35 |
36 | # null out components that will vary
37 | yaml <- site_meta(pkgdown)
38 | yaml$pkgdown <- "{version}"
39 | yaml$pkgdown_sha <- "{sha}"
40 | yaml$pandoc <- "{version}"
41 | yaml$last_built <- timestamp(as.POSIXct("2020-01-01", tz = "UTC"))
42 |
43 | expect_snapshot_output(yaml)
44 | })
45 |
--------------------------------------------------------------------------------
/tests/testthat/test-markdown.R:
--------------------------------------------------------------------------------
1 | test_that("handles empty inputs", {
2 | expect_equal(markdown_text_inline(""), NULL)
3 | expect_equal(markdown_text_inline(NULL), NULL)
4 |
5 | expect_equal(markdown_text_block(NULL), NULL)
6 | expect_equal(markdown_text_block(""), NULL)
7 | })
8 |
9 | test_that("header attributes are parsed", {
10 | text <- markdown_text_block("# Header {.class #id}")
11 | expect_match(text, "id=\"id\"")
12 | expect_match(text, "class=\".*? class\"")
13 | })
14 |
15 | test_that("markdown_text_inline() works with inline markdown", {
16 | expect_equal(markdown_text_inline("**lala**"), "lala ")
17 | expect_snapshot_error(markdown_text_inline("x\n\ny"))
18 | })
19 |
20 | test_that("markdown_text_block() works with inline and block markdown", {
21 | skip_if_no_pandoc("2.17.1")
22 |
23 | expect_equal(markdown_text_block("**x**"), "x
")
24 | expect_equal(markdown_text_block("x\n\ny"), "x
y
")
25 | })
26 |
27 | test_that("markdown_body() captures title", {
28 | temp <- withr::local_tempfile()
29 | write_lines("# Title\n\nSome text", temp)
30 |
31 | html <- markdown_body(temp)
32 | expect_equal(attr(html, "title"), "Title")
33 |
34 | # And can optionally strip it
35 | html <- markdown_body(temp, strip_header = TRUE)
36 | expect_equal(attr(html, "title"), "Title")
37 | expect_false(grepl("Title", html))
38 | })
39 |
40 | test_that("markdown_text_*() handles UTF-8 correctly", {
41 | expect_equal(markdown_text_block("\u00f8"), "\u00f8
")
42 | expect_equal(markdown_text_inline("\u00f8"), "\u00f8")
43 | })
44 |
--------------------------------------------------------------------------------
/inst/BS5/templates/navbar.html:
--------------------------------------------------------------------------------
1 | {{#navbar}}
2 |
3 |
4 | {{#includes}}{{{before_title}}}{{/includes}}
5 |
{{#site}}{{title}}{{/site}}
6 |
7 |
{{#package}}{{version}}{{/package}}
8 |
9 | {{#includes}}{{{before_navbar}}}{{/includes}}
10 |
11 |
13 |
14 |
15 | {{#left}}
16 |
19 | {{/left}}
20 |
21 |
24 |
25 | {{#right}}
26 |
29 | {{/right}}
30 |
31 |
32 | {{#includes}}{{{after_navbar}}}{{/includes}}
33 |
35 | {{/navbar}}
36 |
--------------------------------------------------------------------------------
/R/build-redirects.R:
--------------------------------------------------------------------------------
1 | build_redirects <- function(pkg = ".",
2 | override = list()) {
3 | pkg <- section_init(pkg, depth = 1L, override = override)
4 |
5 | redirects <- c(
6 | article_redirects(pkg),
7 | pkg$meta$redirects
8 | )
9 |
10 | if (is.null(redirects)) {
11 | return(invisible())
12 | }
13 |
14 | rule("Building redirects")
15 | if (is.null(pkg$meta$url)) {
16 | abort(sprintf("%s required to generate redirects", pkgdown_field(pkg, "url")))
17 | }
18 |
19 | purrr::iwalk(
20 | redirects,
21 | build_redirect,
22 | pkg = pkg
23 | )
24 | }
25 |
26 | build_redirect <- function(entry, index, pkg) {
27 | if (!is.character(entry) || length(entry) != 2) {
28 | abort(
29 | sprintf(
30 | "Entry %s in %s must be a character vector of length 2.",
31 | index,
32 | pkgdown_field(pkg, "redirects")
33 | )
34 | )
35 | }
36 |
37 | new <- entry[2]
38 | old <- path(pkg$dst_path, entry[1])
39 |
40 | path <- find_template("layout", "redirect", pkg = pkg)
41 | template <- read_file(path)
42 |
43 | url <- sprintf("%s/%s%s", pkg$meta$url, pkg$prefix, new)
44 | lines <- whisker::whisker.render(template, list(url = url))
45 | dir_create(path_dir(old))
46 | write_lines(lines, old)
47 | }
48 |
49 | article_redirects <- function(pkg) {
50 | if (is.null(pkg$meta$url)) {
51 | return(NULL)
52 | }
53 |
54 | is_vig_in_articles <- path_has_parent(pkg$vignettes$name, "articles")
55 | if (!any(is_vig_in_articles)) {
56 | return(NULL)
57 | }
58 |
59 | articles <- pkg$vignettes$file_out[is_vig_in_articles]
60 | purrr::map(articles, ~ paste0(c("articles/", ""), .x))
61 | }
62 |
--------------------------------------------------------------------------------
/tests/testthat/test-development.R:
--------------------------------------------------------------------------------
1 | test_that("empty yaml gets correct defaults", {
2 | dev <- meta_development(list())
3 | expect_equal(dev$mode, "default")
4 | expect_equal(dev$in_dev, FALSE)
5 | expect_equal(dev$version_label, "default")
6 | })
7 |
8 | test_that("mode = auto uses version", {
9 | dev <- meta_development(
10 | list(development = list(mode = "auto")),
11 | package_version("1.0.0.9000")
12 | )
13 | expect_equal(dev$mode, "devel")
14 | expect_equal(dev$in_dev, TRUE)
15 | expect_equal(dev$version_label, "danger")
16 | })
17 |
18 | test_that("mode overrides version", {
19 | dev <- meta_development(
20 | list(development = list(mode = "release")),
21 | package_version("1.0.0.9000")
22 | )
23 |
24 | expect_equal(dev$mode, "release")
25 | expect_equal(dev$in_dev, FALSE)
26 | expect_equal(dev$version_label, "default")
27 | })
28 |
29 | test_that("dev_mode recognises basic version structure", {
30 | expect_equal(dev_mode_auto("0.0.0.9000"), "unreleased")
31 |
32 | expect_equal(dev_mode_auto("0.0.1"), "release")
33 |
34 | expect_equal(dev_mode_auto("0.1"), "release")
35 | expect_equal(dev_mode_auto("0.1.0"), "release")
36 | expect_equal(dev_mode_auto("0.1.9000"), "devel")
37 |
38 | expect_equal(dev_mode_auto("1.0"), "release")
39 | expect_equal(dev_mode_auto("1.0.0"), "release")
40 | expect_equal(dev_mode_auto("1.0.0.9000"), "devel")
41 | })
42 |
43 | test_that("can override dev_mode with env var", {
44 | withr::local_envvar("PKGDOWN_DEV_MODE" = "devel")
45 | expect_equal(dev_mode("1.0", list()), "devel")
46 | })
47 |
48 | test_that("bad mode yields good error", {
49 | expect_snapshot(check_mode("foo"), error = TRUE)
50 | })
51 |
--------------------------------------------------------------------------------
/inst/BS5/templates/content-article.html:
--------------------------------------------------------------------------------
1 | {{^as_is}}$for(header-includes)$
2 | $header-includes$
3 | $endfor${{/as_is}}
4 |
5 |
6 |
7 |
35 |
36 | $for(include-before)$
37 | $include-before$
38 | $endfor$
39 |
40 | $if(abstract)$
41 |
42 |
Abstract
43 | $abstract$
44 |
49 | {{#toc}}
50 |
51 |
52 | {{#translate}}{{on_this_page}}{{/translate}}
53 |
54 |
55 | {{/toc}}
56 |
57 |
2 |
3 |
6 |
7 |
8 |
9 |
10 | {{#has_icons}}
14 |
15 | {{#rows}}
16 | {{#title}}
17 |
18 | {{{title}}}
19 | {{{desc}}}
20 |
21 | {{/title}}
22 | {{#subtitle}}
23 |
24 | {{{subtitle}}}
25 | {{{desc}}}
26 |
27 | {{/subtitle}}
28 | {{#topics}}
29 | {{#has_icons}}{{#icon}} {{/has_icons}}
30 |
31 | {{#aliases}}{{{.}}}
32 |
33 | {{{title}}}
{{/topics}}
35 | {{/rows}}
36 |
37 |
38 |
39 |
44 |
noodlr
")
28 | })
29 |
30 | test_that("can use custom components", {
31 | pkg <- structure(list(
32 | desc = desc::desc(text = "Authors@R: person('a', 'b', roles = 'cre')"),
33 | meta = list(
34 | footer = list(
35 | structure = list(left = "test"),
36 | components = list(test = "_test_")
37 | )
38 | )),
39 | class = "pkgdown"
40 | )
41 | expect_equal(data_footer(pkg)$left, "test
")
42 | })
43 |
44 | test_that("multiple components are pasted together", {
45 | pkg <- structure(list(
46 | desc = desc::desc(text = "Authors@R: person('a', 'b', roles = 'cre')"),
47 | meta = list(
48 | footer = list(
49 | structure = list(left = c("a", "b")),
50 | components = list(a = "a", b = "b")
51 | )
52 | )),
53 | class = "pkgdown"
54 | )
55 | expect_equal(data_footer(pkg)$left, "a b
")
56 | })
57 |
58 |
--------------------------------------------------------------------------------
/inst/BS3/templates/content-article.html:
--------------------------------------------------------------------------------
1 | {{^as_is}}$for(header-includes)$
2 | $header-includes$
3 | $endfor${{/as_is}}
4 |
5 |
6 |
7 |
35 |
36 | $for(include-before)$
37 | $include-before$
38 | $endfor$
39 |
40 | $if(abstract)$
41 |
42 |
Abstract
43 | $abstract$
44 |
45 | $endif$
46 |
47 | $body$
48 |
49 |
50 |
61 |
62 |
3 |
4 |
16 |
17 |
18 | {{#left}}
19 |
22 | {{/left}}
23 | {{#right}}
24 |
27 | {{/right}}
28 | {{#yaml}}{{#docsearch}}
29 |
34 | {{/docsearch}}{{/yaml}}
35 |
36 |
37 |
", "",
48 | x,
49 | "",""
50 | )
51 | }
52 |
53 | sourceCode <- function(x) {
54 | paste0("", x, "
")
55 | }
56 |
--------------------------------------------------------------------------------
/inst/highlight-styles/a11y-dark.scss:
--------------------------------------------------------------------------------
1 | pre {background-color: #2b2b2b;}
2 | pre code /* Normal */ {color:#f8f8f2}
3 | pre code span.al /* Alert */ {color:#dcc6e0}
4 | pre code span.an /* Annotation */ {color:#d4d0ab}
5 | pre code span.at /* Attribute */ {color:#ffd700}
6 | pre code span.bn /* BaseN */ {color:#dcc6e0}
7 | pre code span.bu /* BuiltIn */ {}
8 | pre code span.cf /* ControlFlow */ {color:#ffa07a}
9 | pre code span.ch /* Char */ {color:#abe338}
10 | pre code span.cn /* Constant */ {color:#ffa07a}
11 | pre code span.co /* Comment */ {color:#d4d0ab}
12 | pre code span.cv /* CommentVar */ {color:#d4d0ab; font-style: italic}
13 | pre code span.do /* Documentation */ {color:#d4d0ab; font-style: italic}
14 | pre code span.dt /* DataType */ {color:#dcc6e0}
15 | pre code span.dv /* DecVal */ {color:#dcc6e0}
16 | pre code span.er /* Error */ {color:#dcc6e0}
17 | pre code span.ex /* Extension */ {}
18 | pre code span.fl /* Float */ {color:#f5ab35}
19 | pre code span.fu /* Function */ {color:#ffd700}
20 | pre code span.im /* Import */ {}
21 | pre code span.in /* Information */ {color:#d4d0ab}
22 | pre code span.kw /* Keyword */ {color:#ffa07a}
23 | pre code span.op /* Operator */ {color:#00e0e0}
24 | pre code span.ot /* Other */ {color:#ffa07a}
25 | pre code span.pp /* Preprocessor */ {color:#dcc6e0}
26 | pre code span.sc /* SpecialChar */ {color:#00e0e0}
27 | pre code span.ss /* SpecialString */ {color:#abe338}
28 | pre code span.st /* String */ {color:#abe338}
29 | pre code span.va /* Variable */ {color:#f5ab35}
30 | pre code span.vs /* VerbatimString */ {color:#abe338}
31 | pre code span.wa /* Warning */ {color:#d4d0ab; font-style: italic}
32 |
--------------------------------------------------------------------------------
/inst/highlight-styles/a11y-light.scss:
--------------------------------------------------------------------------------
1 | pre {background-color: #fefefe;}
2 | pre code /* Normal */ {color:#545454}
3 | pre code span.al /* Alert */ {color:#7928a1}
4 | pre code span.an /* Annotation */ {color:#696969}
5 | pre code span.at /* Attribute */ {color:#aa5d00}
6 | pre code span.bn /* BaseN */ {color:#7928a1}
7 | pre code span.bu /* BuiltIn */ {}
8 | pre code span.cf /* ControlFlow */ {color:#d91e18}
9 | pre code span.ch /* Char */ {color:#008000}
10 | pre code span.cn /* Constant */ {color:#d91e18}
11 | pre code span.co /* Comment */ {color:#696969}
12 | pre code span.cv /* CommentVar */ {color:#696969; font-style: italic}
13 | pre code span.do /* Documentation */ {color:#696969; font-style: italic}
14 | pre code span.dt /* DataType */ {color:#7928a1}
15 | pre code span.dv /* DecVal */ {color:#7928a1}
16 | pre code span.er /* Error */ {color:#7928a1}
17 | pre code span.ex /* Extension */ {}
18 | pre code span.fl /* Float */ {color:#aa5d00}
19 | pre code span.fu /* Function */ {color:#06287e}
20 | pre code span.im /* Import */ {}
21 | pre code span.in /* Information */ {color:#696969}
22 | pre code span.kw /* Keyword */ {color:#d91e18}
23 | pre code span.op /* Operator */ {color:#007faa}
24 | pre code span.ot /* Other */ {color:#d91e18}
25 | pre code span.pp /* Preprocessor */ {color:#7928a1}
26 | pre code span.sc /* SpecialChar */ {color:#007faa}
27 | pre code span.ss /* SpecialString */ {color:#008000}
28 | pre code span.st /* String */ {color:#008000}
29 | pre code span.va /* Variable */ {color:#aa5d00}
30 | pre code span.vs /* VerbatimString */ {color:#008000}
31 | pre code span.wa /* Warning */ {color:#696969; font-style: italic}
32 |
--------------------------------------------------------------------------------
/tests/testthat/test-build-search-docs.R:
--------------------------------------------------------------------------------
1 | test_that("docsearch.json and sitemap.xml are valid", {
2 | pkg <- local_pkgdown_site(test_path("assets/search-site"))
3 |
4 | expect_output(build_site(pkg, new_process = FALSE))
5 | json <- path(pkg$dst_path, "docsearch.json")
6 | expect_true(jsonlite::validate(read_lines(json)))
7 |
8 | xml <- path(pkg$dst_path, "sitemap.xml")
9 | schema <- xml2::read_xml(path(pkg$src_path, "sitemaps-schema-0.9.xsd"))
10 | expect_true(xml2::xml_validate(xml2::read_xml(xml), schema))
11 | })
12 |
13 | test_that("build_search() builds the expected search`.json with an URL", {
14 | pkg <- local_pkgdown_site(test_path("assets/news"), '
15 | url: https://example.com
16 | template:
17 | bootstrap: 5
18 | news:
19 | cran_dates: false
20 | development:
21 | mode: devel
22 | ')
23 |
24 | expect_output(init_site(pkg))
25 | expect_output(build_news(pkg))
26 | expect_output(build_home(pkg))
27 | expect_output(build_sitemap(pkg))
28 |
29 | json_path <- withr::local_tempfile()
30 | jsonlite::write_json(build_search_index(pkg), json_path, pretty = TRUE)
31 | expect_snapshot_file(json_path, "search.json")
32 | })
33 |
34 | test_that("build_search() builds the expected search.json with no URL", {
35 | pkg <- local_pkgdown_site(test_path("assets/news"), '
36 | template:
37 | bootstrap: 5
38 | news:
39 | cran_dates: false
40 | development:
41 | mode: devel
42 | ')
43 |
44 | expect_output(init_site(pkg))
45 | expect_output(build_news(pkg))
46 | expect_output(build_home(pkg))
47 | expect_output(build_sitemap(pkg))
48 |
49 | json_path <- withr::local_tempfile()
50 | jsonlite::write_json(build_search_index(pkg), json_path, pretty = TRUE)
51 | expect_snapshot_file(json_path, "search-no-url.json")
52 | })
53 |
--------------------------------------------------------------------------------
/inst/highlight-styles/arrow-light.scss:
--------------------------------------------------------------------------------
1 | pre {background-color: #f1f3f5;}
2 | pre code /* Normal */ {color:#003B4F}
3 | pre code span.al /* Alert */ {color:#AD0000}
4 | pre code span.an /* Annotation */ {color:#5E5E5E}
5 | pre code span.at /* Attribute */ {color:#657422}
6 | pre code span.bn /* BaseN */ {color:#AD0000}
7 | pre code span.bu /* BuiltIn */ {}
8 | pre code span.cf /* ControlFlow */ {color:#003B4F}
9 | pre code span.ch /* Char */ {color:#20794D}
10 | pre code span.cn /* Constant */ {color:#8f5902}
11 | pre code span.co /* Comment */ {color:#5E5E5E}
12 | pre code span.cv /* CommentVar */ {color:#5E5E5E; font-style: italic}
13 | pre code span.do /* Documentation */ {color:#5E5E5E; font-style: italic}
14 | pre code span.dt /* DataType */ {color:#AD0000}
15 | pre code span.dv /* DecVal */ {color:#AD0000}
16 | pre code span.er /* Error */ {color:#AD0000}
17 | pre code span.ex /* Extension */ {}
18 | pre code span.fl /* Float */ {color:#AD0000}
19 | pre code span.fu /* Function */ {color:#4758AB}
20 | pre code span.im /* Import */ {color:#00769E}
21 | pre code span.in /* Information */ {color:#5E5E5E}
22 | pre code span.kw /* Keyword */ {color:#003B4F}
23 | pre code span.op /* Operator */ {color:#5E5E5E}
24 | pre code span.ot /* Other */ {color:#003B4F}
25 | pre code span.pp /* Preprocessor */ {color:#AD0000}
26 | pre code span.sc /* SpecialChar */ {color:#5E5E5E}
27 | pre code span.ss /* SpecialString */ {color:#20794D}
28 | pre code span.st /* String */ {color:#20794D}
29 | pre code span.va /* Variable */ {color:#111111}
30 | pre code span.vs /* VerbatimString */ {color:#20794D}
31 | pre code span.wa /* Warning */ {color:#5E5E5E; font-style: italic}
32 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/topics.md:
--------------------------------------------------------------------------------
1 | # bad inputs give informative warnings
2 |
3 | Code
4 | t <- select_topics("x + ", topics)
5 | Condition
6 | Error:
7 | ! In '_pkgdown.yml', topic must be valid R code
8 | x Not 'x + '
9 | Code
10 | t <- select_topics("y", topics)
11 | Condition
12 | Error:
13 | ! In '_pkgdown.yml', topic must be a known topic name or alias
14 | x Not 'y'
15 | Code
16 | t <- select_topics("paste(1)", topics)
17 | Condition
18 | Error:
19 | ! In '_pkgdown.yml', topic must be a known selector function
20 | x Not 'paste(1)'
21 | Caused by error in `paste()`:
22 | ! could not find function "paste"
23 | Code
24 | t <- select_topics("starts_with", topics)
25 | Condition
26 | Error:
27 | ! In '_pkgdown.yml', topic must be a known topic name or alias
28 | x Not 'starts_with'
29 | Code
30 | t <- select_topics("1", topics)
31 | Condition
32 | Error:
33 | ! In '_pkgdown.yml', topic must be a string or function call
34 | x Not '1'
35 | Code
36 | t <- select_topics("starts_with('y')", topics, check = TRUE)
37 | Condition
38 | Error in `select_topics()`:
39 | ! No topics matched in '_pkgdown.yml'. No topics selected.
40 |
41 | # can select by name or alias
42 |
43 | Code
44 | select_topics("a4", topics)
45 | Condition
46 | Error:
47 | ! In '_pkgdown.yml', topic must be a known topic name or alias
48 | x Not 'a4'
49 |
50 | # an unmatched selection generates a warning
51 |
52 | Code
53 | select_topics(c("a", "starts_with('unmatched')"), topics, check = TRUE)
54 | Condition
55 | Error:
56 | ! In '_pkgdown.yml', topic must match a function or concept
57 | x Not 'starts_with(\'unmatched\')'
58 |
59 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/build-news.md:
--------------------------------------------------------------------------------
1 | # data_news works as expected for h1 & h2
2 |
3 | # A tibble: 2 x 3
4 | version page anchor
5 |
6 | 1 1.0.0.9000 dev testpackage-1009000
7 | 2 1.0.0 1.0 testpackage-100
8 |
9 | ---
10 |
11 | # A tibble: 2 x 3
12 | version page anchor
13 |
14 | 1 1.0.0.9000 dev testpackage-1009000
15 | 2 1.0.0 1.0 testpackage-100
16 |
17 | # multi-page news are rendered
18 |
19 | # A tibble: 4 x 3
20 | version page anchor
21 |
22 | 1 2.0 2.0 testpackage-20
23 | 2 1.1 1.1 testpackage-11
24 | 3 1.0.1 1.0 testpackage-101
25 | 4 1.0.0 1.0 testpackage-100
26 |
27 | # news headings get class and release date
28 |
29 |
30 |
33 |
34 |
35 | ---
36 |
37 |
38 |
39 |
CRAN release: 2020-01-01
40 |
or all .
46 | i See ?build_news for more details.
47 |
48 | # clear error for bad hierarchy - h3
49 |
50 | Invalid NEWS.md: inconsistent use of section headings.
51 | i Top-level headings must be either all or all .
52 | i See ?build_news for more details.
53 |
54 | # news can contain footnotes
55 |
56 | Code
57 | x <- data_news(pkg)
58 | Condition
59 | Warning:
60 | Footnotes in NEWS.md are not currently suppoted
61 |
62 |
--------------------------------------------------------------------------------
4 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph/NAMESPACE:
--------------------------------------------------------------------------------
1 | # Generated by roxygen2: do not edit by hand
2 |
3 | export(f)
4 |
--------------------------------------------------------------------------------
/tests/testthat/assets/pandoc-fail.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "pandoc-fail"
3 | ---
4 |
5 | 
6 |
--------------------------------------------------------------------------------
/tests/testthat/assets/home-index-rmd/index.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | output: github_document
3 | ---
4 |
5 | This is a test
6 |
--------------------------------------------------------------------------------
/tests/testthat/assets/home-readme-rmd/README.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | output: github_document
3 | ---
4 |
5 | This is a test
6 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph-customized/R/f.R:
--------------------------------------------------------------------------------
1 | #' Title
2 | #'
3 | #' @export
4 | f <- function() {
5 |
6 | }
7 |
--------------------------------------------------------------------------------
/tests/testthat/assets/reference-fail/NAMESPACE:
--------------------------------------------------------------------------------
1 | # Generated by roxygen2: do not edit by hand
2 |
3 | export(f)
4 |
--------------------------------------------------------------------------------
/tests/testthat/assets/reference-html-dep/NAMESPACE:
--------------------------------------------------------------------------------
1 | # Generated by roxygen2: do not edit by hand
2 |
3 | export(a)
4 |
--------------------------------------------------------------------------------
/tests/testthat/assets/reference-html-dep/_pkgdown.yml:
--------------------------------------------------------------------------------
1 | url: http://test.org
2 |
3 | template:
4 | bootstrap: 5
5 |
--------------------------------------------------------------------------------
/pkgdown/favicon/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/favicon-16x16.png
--------------------------------------------------------------------------------
/pkgdown/favicon/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/favicon-32x32.png
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph-customized/NAMESPACE:
--------------------------------------------------------------------------------
1 | # Generated by roxygen2: do not edit by hand
2 |
3 | export(f)
4 |
--------------------------------------------------------------------------------
/inst/po/de/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/de/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/inst/po/dk/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/dk/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/inst/po/es/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/es/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/inst/po/fr/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/fr/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/inst/po/ko/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/ko/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/inst/po/kr/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/kr/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/inst/po/pt/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/pt/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/inst/po/tr/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/tr/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/pkgdown/favicon/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/apple-touch-icon.png
--------------------------------------------------------------------------------
/revdep/.gitignore:
--------------------------------------------------------------------------------
1 | checks
2 | library
3 | checks.noindex
4 | library.noindex
5 | data.sqlite
6 | *.html
7 | cloud.noindex
8 |
--------------------------------------------------------------------------------
/tests/testthat/assets/reference-fail/R/f.R:
--------------------------------------------------------------------------------
1 | #' Title
2 | #'
3 | #' \url{}
4 | #' @export
5 | f <- function() {
6 |
7 | }
8 |
--------------------------------------------------------------------------------
/vignettes/test/short.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "A short page"
3 | ---
4 |
5 | The footer should hug the bottom of the viewport.
6 |
--------------------------------------------------------------------------------
/inst/po/zh_CN/LC_MESSAGES/R-pkgdown.mo:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/inst/po/zh_CN/LC_MESSAGES/R-pkgdown.mo
--------------------------------------------------------------------------------
/tests/testthat/assets/figure/_pkgdown.yml:
--------------------------------------------------------------------------------
1 | figures:
2 | dev: "jpeg"
3 | fig.ext: "jpg"
4 | fig.width: 3
5 | fig.asp: 1
6 |
--------------------------------------------------------------------------------
/tests/testthat/assets/figure/vignettes/figures.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Test: Figures"
3 | ---
4 |
5 | ```{r}
6 | plot(1:10)
7 | ```
8 |
--------------------------------------------------------------------------------
/tests/testthat/assets/site-dot-github/.github/404.md:
--------------------------------------------------------------------------------
1 | # Page not found (404)
2 |
3 | Please use the links in the navigation bar.
4 |
--------------------------------------------------------------------------------
/pkgdown/favicon/apple-touch-icon-60x60.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/apple-touch-icon-60x60.png
--------------------------------------------------------------------------------
/pkgdown/favicon/apple-touch-icon-76x76.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/apple-touch-icon-76x76.png
--------------------------------------------------------------------------------
/tests/testthat/assets/articles/vignettes/width.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Width"
3 | ---
4 |
5 | ```{r}
6 | getOption("width")
7 | ```
8 |
9 |
--------------------------------------------------------------------------------
/tests/testthat/assets/man-figures/_pkgdown.yml:
--------------------------------------------------------------------------------
1 | figures:
2 | dev: "jpeg"
3 | fig.ext: "jpg"
4 | fig.width: 3
5 | fig.asp: 1
6 |
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/open-graph/logo.png
--------------------------------------------------------------------------------
/pkgdown/favicon/apple-touch-icon-120x120.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/apple-touch-icon-120x120.png
--------------------------------------------------------------------------------
/pkgdown/favicon/apple-touch-icon-152x152.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/apple-touch-icon-152x152.png
--------------------------------------------------------------------------------
/pkgdown/favicon/apple-touch-icon-180x180.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/pkgdown/favicon/apple-touch-icon-180x180.png
--------------------------------------------------------------------------------
/tests/testthat/assets/site-bad-logo/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/site-bad-logo/logo.png
--------------------------------------------------------------------------------
/tests/testthat/assets/site-favicons/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/site-favicons/logo.png
--------------------------------------------------------------------------------
/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | # CODEOWNERS for pkgdown
2 | # https://www.tidyverse.org/development/understudies
3 | .github/CODEOWNERS @hadley @jayhesselberth
4 |
--------------------------------------------------------------------------------
/tests/testthat/assets/reference/NAMESPACE:
--------------------------------------------------------------------------------
1 | # Generated by roxygen2: do not edit by hand
2 |
3 | export("?")
4 | export(a)
5 | export(b)
6 | export(c)
7 |
--------------------------------------------------------------------------------
/inst/rstudio/addins.dcf:
--------------------------------------------------------------------------------
1 | Name: Build pkgdown
2 | Description: Runs pkgdown on the current package
3 | Binding: build_site_external
4 | Interactive: true
5 |
--------------------------------------------------------------------------------
/tests/testthat/assets/man-figures/man/figures/kitten.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/man-figures/man/figures/kitten.jpg
--------------------------------------------------------------------------------
/tests/testthat/assets/man-figures/man/kitten.Rd:
--------------------------------------------------------------------------------
1 | \name{kitten}
2 | \alias{kitten}
3 | \title{A picture of a kitten}
4 | \description{
5 | \figure{kitten.jpg}
6 | }
7 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/build-redirects.md:
--------------------------------------------------------------------------------
1 | # build_redirect() errors if one entry is not right.
2 |
3 | Entry 5 in redirects must be a character vector of length 2.
4 |
5 |
--------------------------------------------------------------------------------
/tests/testthat/assets/man-figures/vignettes/another-kitten.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/man-figures/vignettes/another-kitten.jpg
--------------------------------------------------------------------------------
/tests/testthat/assets/open-graph-customized/man/figures/card.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/open-graph-customized/man/figures/card.png
--------------------------------------------------------------------------------
/tests/testthat/assets/site-citation/encoding-latin1/DESCRIPTION:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/site-citation/encoding-latin1/DESCRIPTION
--------------------------------------------------------------------------------
/tests/testthat/assets/site-favicons/pkgdown/favicon/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/site-favicons/pkgdown/favicon/favicon.ico
--------------------------------------------------------------------------------
/tests/testthat/_snaps/build-logo.md:
--------------------------------------------------------------------------------
1 | # can handle logo in subdir
2 |
3 | Code
4 | copy_logo(pkg)
5 | Output
6 | Copying 'man/figures/logo.svg' to 'logo.svg'
7 |
8 |
--------------------------------------------------------------------------------
/tests/testthat/assets/articles/vignettes/articles/nested.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Standard article"
3 | ---
4 |
5 | Source is nested in vignettes/articles, output should be in /articles/
6 |
--------------------------------------------------------------------------------
/tests/testthat/assets/site-citation/encoding-latin1/inst/CITATION:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/datacamp/pkgdown/master/tests/testthat/assets/site-citation/encoding-latin1/inst/CITATION
--------------------------------------------------------------------------------
/tests/testthat/assets/site-dot-github/README.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | output: github_document
3 | ---
4 |
5 | # test
6 |
7 | test link to [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md)
8 |
--------------------------------------------------------------------------------
/vignettes/test/pdf.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | title: "PDF"
3 | output: pdf_document
4 | pkgdown:
5 | as_is: true
6 | extension: pdf
7 | ---
8 |
9 | # Heading
10 |
11 | Some text
12 |
13 |
--------------------------------------------------------------------------------
/tests/testthat/_snaps/markdown.md:
--------------------------------------------------------------------------------
1 | # markdown_text_inline() works with inline markdown
2 |
3 | Can't use a block element in 
{{/icon}}{{/has_icons}} 16 | {{#aliases}}