html_document2.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/html.R, R/latex.R, R/word.R
\name{html_document2}
\alias{html_document2}
\alias{tufte_html2}
\alias{pdf_document2}
\alias{tufte_handout2}
\alias{tufte_book2}
\alias{word_document2}
\title{Output formats that allow numbering and cross-referencing
figures/tables/equations}
\usage{
html_document2(..., number_sections = TRUE, pandoc_args = NULL, 
    base_format = rmarkdown::html_document)

tufte_html2(..., number_sections = FALSE)

pdf_document2(...)

tufte_handout2(...)

tufte_book2(...)

word_document2(fig_caption = TRUE, md_extensions = NULL, pandoc_args = NULL, 
    ...)
}
\arguments{
\item{..., 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
\code{html_document2()} are passed to \code{rmarkdown::html_document()}.}

\item{number_sections}{Whether to number section headers: if \code{TRUE},
figure/table numbers will be of the form \code{X.i}, where \code{X} is the
current first-level section number, and \code{i} is an incremental number
(the i-th figure/table); if \code{FALSE}, figures/tables will be numbered
sequentially in the document from 1, 2, ..., and you cannot cross-reference
section headers in this case.}

\item{base_format}{An output format function to be used as the base format.}
}
\value{
An R Markdown output format object to be passed to
  \code{rmarkdown::\link{render}()}.
}
\description{
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
References for the syntax. Note you can also cross-reference sections by
their ID's using the same syntax when sections are numbered.
}
\note{
These function are expected to work with a single R Markdown document
  instead of multiple documents of a book, so they are to be passed to
  \code{rmarkdown::render()} instead of \code{bookdown::render_book()}. The
  functions \samp{tufte_*()} are wrappers of funtions in the \pkg{tufte}
  package.
}
\references{
\url{https://bookdown.org/yihui/bookdown/}
}