diff --git a/R/use.R b/R/use.R index 139241ae..7c45b687 100644 --- a/R/use.R +++ b/R/use.R @@ -12,11 +12,13 @@ #' @return No value returned. Creates files in folder 'docs'. Other files and #' folders are not modified. #' -#' Note that vignettes are no longer automatically added to the file that -#' defines the structure of the website. Developers must now manually update -#' this structure and the order of their articles. The name of the file defining -#' the structure of the website lives at the root of `/docs` and differs based -#' on the selected site builder (`use_docsify()` = `_sidebar.md`; +#' @details +#' # Vignettes +#' Note that although vignettes are automatically moved to the `/docs` folder, +#' they are no longer automatically specified in the website structure-defining +#' file. Developers must now manually update this file and the desired order of +#' their articles. This file lives at the root of `/docs` and its name differs +#' based on the selected site builder (`use_docsify()` = `_sidebar.md`; #' `use_docute()` = `index.html`; `use_mkdocs()` = `mkdocs.yml`). #' #' @rdname init diff --git a/man/init.Rd b/man/init.Rd index 96ac9c64..e2fc1fe2 100644 --- a/man/init.Rd +++ b/man/init.Rd @@ -33,13 +33,6 @@ section.} \value{ No value returned. Creates files in folder 'docs'. Other files and folders are not modified. - -Note that vignettes are no longer automatically added to the file that -defines the structure of the website. Developers must now manually update -this structure and the order of their articles. The name of the file defining -the structure of the website lives at the root of \verb{/docs} and differs based -on the selected site builder (\code{use_docsify()} = \verb{_sidebar.md}; -\code{use_docute()} = \code{index.html}; \code{use_mkdocs()} = \code{mkdocs.yml}). } \description{ Init Docute, Docsify, or Mkdocs @@ -49,6 +42,15 @@ If you are new to Mkdocs, the themes "readthedocs" and "material" are among the most popular and developed. You can also see a list of themes here: \url{https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes}. } +\section{Vignettes}{ +Note that although vignettes are automatically moved to the \verb{/docs} folder, +they are no longer automatically specified in the website structure-defining +file. Developers must now manually update this file and the desired order of +their articles. This file lives at the root of \verb{/docs} and its name differs +based on the selected site builder (\code{use_docsify()} = \verb{_sidebar.md}; +\code{use_docute()} = \code{index.html}; \code{use_mkdocs()} = \code{mkdocs.yml}). +} + \examples{ if (interactive()) { # Create docute documentation