Skip to content

Commit

Permalink
be specific about the link dest
Browse files Browse the repository at this point in the history
  • Loading branch information
yihui committed Jul 2, 2024
1 parent 716c4cc commit bd600ba
Show file tree
Hide file tree
Showing 10 changed files with 29 additions and 27 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Suggests:
URL: https://github.com/rstudio/bookdown, https://pkgs.rstudio.com/bookdown/
BugReports: https://github.com/rstudio/bookdown/issues
SystemRequirements: Pandoc (>= 1.17.2)
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
Encoding: UTF-8
Config/Needs/book: remotes, webshot, svglite
Config/Needs/website: pkgdown, tidyverse/tidytemplate, rstudio/quillt
Expand Down
2 changes: 1 addition & 1 deletion R/gitbook.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#'
#' @inheritParams html_chapters
#' @param fig_caption,number_sections,self_contained,anchor_sections,lib_dir,pandoc_args,code_folding,extra_dependencies,...
#' Arguments to be passed to \code{rmarkdown::\link{html_document}()}
#' Arguments to be passed to \code{rmarkdown::\link[rmarkdown]{html_document}()}
#' (\code{...} not including \code{toc}, and \code{theme}).
#' @param template Pandoc template to use for rendering. Pass \code{"default"}
#' to use the bookdown default template; pass a path to use a custom template.
Expand Down
16 changes: 8 additions & 8 deletions R/html.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#' @inheritParams pdf_book
#' @inheritParams html_document2
#' @param toc,number_sections,fig_caption,lib_dir,template,pandoc_args See
#' \code{rmarkdown::\link{html_document}},
#' \code{rmarkdown::\link[rmarkdown]{html_document}},
#' \code{tufte::\link[tufte:tufte_handout]{tufte_html}}, or the documentation
#' of the \code{base_format} function.
#' @param ... Other arguments to be passed to \code{base_format}. For
Expand Down Expand Up @@ -97,12 +97,12 @@ tufte_html_book = function(...) {
#' figures/tables/equations
#'
#' These are simple wrappers of the output format functions like
#' \code{rmarkdown::\link{html_document}()}, and they added the capability of
#' numbering figures/tables/equations/theorems and cross-referencing them. See
#' \sQuote{References} for the syntax. Note you can also cross-reference
#' sections by their ID's using the same syntax when sections are numbered. In
#' case you want to enable cross reference in other formats, use
#' \code{markdown_document2} with \code{base_format} argument.
#' \code{rmarkdown::\link[rmarkdown]{html_document}()}, and they added the
#' capability of numbering figures/tables/equations/theorems and
#' cross-referencing them. See \sQuote{References} for the syntax. Note you can
#' also cross-reference sections by their ID's using the same syntax when
#' sections are numbered. In case you want to enable cross reference in other
#' formats, use \code{markdown_document2} with \code{base_format} argument.
#' @param ...,fig_caption,md_extensions,pandoc_args Arguments to be passed to a
#' specific output format function. For a function \code{foo2()}, its
#' arguments are passed to \code{foo()}, e.g. \code{...} of
Expand All @@ -121,7 +121,7 @@ tufte_html_book = function(...) {
#' are not numbered.
#' @inheritParams pdf_book
#' @return An R Markdown output format object to be passed to
#' \code{rmarkdown::\link{render}()}.
#' \code{rmarkdown::\link[rmarkdown]{render}()}.
#' @note These output formats are used to generate single output files, such as
#' a single HTML output file (unlike \code{gitbook}, which generates multiple
#' HTML output files by default).
Expand Down
4 changes: 2 additions & 2 deletions R/latex.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
#' to be written to the \file{.tex} output file. This gives you full power to
#' post-process the LaTeX output.
#' @param toc,number_sections,fig_caption,pandoc_args See
#' \code{rmarkdown::\link{pdf_document}}, or the documentation of the
#' \code{base_format} function.
#' \code{rmarkdown::\link[rmarkdown]{pdf_document}}, or the documentation of
#' the \code{base_format} function.
#' @param ... Other arguments to be passed to \code{base_format}.
#' @param base_format An output format function to be used as the base format.
#' @param toc_unnumbered Whether to add unnumbered headers to the table of
Expand Down
5 changes: 3 additions & 2 deletions R/render.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
#' specified in this argument are rendered, otherwise all R Markdown files
#' specified by the book are rendered.
#' @param output_format,...,clean,envir Arguments to be passed to
#' \code{rmarkdown::\link{render}()}. For \code{preview_chapter()}, \code{...}
#' is passed to \code{render_book()}. See \code{rmarkdown::\link{render}()}
#' \code{rmarkdown::\link[rmarkdown]{render}()}. For \code{preview_chapter()},
#' \code{...} is passed to \code{render_book()}. See
#' \code{rmarkdown::\link{render}()}
#' and \href{https://bookdown.org/yihui/bookdown/build-the-book.html}{the
#' bookdown reference book} for details on how output formatting options are
#' set from YAML or parameters supplied by the user when calling
Expand Down
2 changes: 1 addition & 1 deletion man/gitbook.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/html_chapters.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions man/html_document2.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/pdf_book.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/render_book.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit bd600ba

Please sign in to comment.