diff --git a/R/build-articles.R b/R/build-articles.R index ddeb27406..8ea5df88e 100644 --- a/R/build-articles.R +++ b/R/build-articles.R @@ -19,7 +19,7 @@ #' package, not the current source version. This makes iteration quicker when #' you are primarily working on the text of an article. #' -#' @section Index and navbar: +#' # Index and navbar #' You can control the articles index and navbar with a `articles` field in #' your `_pkgdown.yml`. If you use it, pkgdown will check that all articles #' are included, and will error if you have missed any. @@ -77,7 +77,7 @@ #' the navbar, it will link directly to the articles index instead of #' providing a drop-down. #' -#' @section Get started: +#' # Get started #' Note that a vignette with the same name as the package (e.g., #' `vignettes/pkgdown.Rmd` or `vignettes/articles/pkgdown.Rmd`) automatically #' becomes a top-level "Get started" link, and will not appear in the articles @@ -86,7 +86,7 @@ #' (If your package name includes a `.`, e.g. `pack.down`, use a `-` in the #' vignette name, e.g. `pack-down.Rmd`.) #' -#' @section External files: +#' # External files #' pkgdown differs from base R in its handling of external files. When building #' vignettes, R assumes that vignettes are self-contained (a reasonable #' assumption when most vignettes were PDFs) and only copies files explicitly @@ -107,7 +107,7 @@ #' Note that you can not use the `fig.path` to change the output directory of #' generated figures as its default value is a strong assumption of rmarkdown. #' -#' @section Embedding Shiny apps: +#' # Embedding Shiny apps #' If you would like to embed a Shiny app into an article, the app will have #' to be hosted independently, (e.g. ). Then, you #' can embed the app into your article using an `