forked from rstudio/blogdown
-
Notifications
You must be signed in to change notification settings - Fork 0
/
html_page.Rd
45 lines (42 loc) · 1.82 KB
/
html_page.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/format.R
\name{html_page}
\alias{html_page}
\title{An R Markdown output format for \pkg{blogdown} web pages}
\usage{
html_page(..., number_sections = FALSE, self_contained = FALSE,
highlight = NULL, template = NULL, post_processor = NULL)
}
\arguments{
\item{..., number_sections, self_contained, highlight, template}{Arguments passed
to \code{bookdown::html_document2()} (note the option \code{theme} is not
supported and set to \code{NULL} internally, and when \code{template =
NULL}, a default template in \pkg{blogdown} will be used).}
\item{post_processor}{Passed to \code{rmarkdown::\link{output_format}}.}
}
\description{
This function is a simple wrapper of \code{bookdown::\link{html_document2}()}
with different default arguments, and more importantly, a special HTML
template designed only for \pkg{blogdown} to render R Markdown to HTML pages
that can be processed by Hugo.
}
\details{
The HTML output is not a complete HTML document, and only meaningful to
\pkg{blogdown} (it will be post-processed to render valid HTML pages). The
only purpose of this output format is for users to change options in YAML.
The fact that it is based on \pkg{bookdown} means most \pkg{bookdown}
features are supported, such as numbering and cross-referencing
figures/tables.
}
\note{
Do not use a custom template unless you understand how the default
template actually works (see the \pkg{blogdown} book).
The argument \code{highlight} does not support the value \code{"textmate"},
and the argument \code{template} does not support the value
\code{"default"}.
}
\references{
See Chapter 2 of the \pkg{bookdown} book for the Markdown syntax:
\url{https://bookdown.org/yihui/bookdown}. See the \pkg{blogdown} book for
full details: \url{https://bookdown.org/yihui/blogdown}.
}