Document authors and re-pkg

r-lib · Oct 25, 2016 · 41156e3 · 41156e3
1 parent e93de96
commit 41156e3
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 19 deletions.
diff --git a/R/build.r b/R/build.r
@@ -11,12 +11,26 @@
 #' that aspect of the site.
 #'
 #' @section YAML config:
-#' There are four top-level YAML settings that affect the entire site:
+#' There are five top-level YAML settings that affect the entire site:
 #' \code{title}, \code{template}, and \code{navbar}.
 #'
 #' \code{title} overrides the default site title, which is the package name.
 #' It's used in the page title and default navbar.
 #'
+#' You can also provided information to override the default display of
+#' the authors. Provided a list named with the name of each author,
+#' including \code{href} to add a link, or \code{html} to override the
+#' text:
+#'
+#' \preformatted{
+#' authors:
+#'   Hadley Wickham:
+#'     href: http://hadley.nz
+#'   RStudio:
+#'     href: https://www.rstudio.com
+#'     html: <img src="http://tidyverse.org/rstudio-logo.svg" height="24" />
+#' }
+#'
 #' @section YAML config - navbar:
 #' \code{navbar} controls the navbar at the top of the page. It uses the same
 #' syntax as \href{RMarkdown}{http://rmarkdown.rstudio.com/rmarkdown_websites.html#site_navigation}.

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -2,13 +2,6 @@ templates:
   params:
     bootswatch: cerulean
 
-authors:
-  Hadley Wickham:
-    href: http://hadley.nz
-  RStudio:
-    href: https://www.rstudio.com
-    html: <img src="http://tidyverse.org/rstudio-logo.svg" height="24" />
-
 reference:
   - title: Build
     desc:  Build each component of the site.

diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/reference/build_articles.html b/docs/reference/build_articles.html
diff --git a/docs/reference/build_home.html b/docs/reference/build_home.html
diff --git a/docs/reference/build_news.html b/docs/reference/build_news.html
diff --git a/docs/reference/build_reference.html b/docs/reference/build_reference.html
diff --git a/docs/reference/build_site.html b/docs/reference/build_site.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/render_page.html b/docs/reference/render_page.html
diff --git a/docs/reference/templates.html b/docs/reference/templates.html
diff --git a/man/build_site.Rd b/man/build_site.Rd