R/start_page.R

Defines functions start_page

Documented in start_page

#' Create a page object
#'
#' Create an HTML page object, which can
#' be passed to other builder functions.
#' This starts a page with the
#' necessary components.
#' @examples
#' # Start building an HTML page with the
#' # `start_page()` function
#' page <- start_page()
#'
#' # The page is a simple list object
#' page
#'
#' # The page can be viewed in RStudio
#' # with the `show_in_viewer()` function,
#' # but, let's add some viewable content
#' # first with `p_()`:
#' page %>%
#'   p_("**Hello!** This is just text.") %>%
#'   show_in_viewer()
#' @export
start_page <- function() {

  initialize_object(
    type = c(
      "_dtd", "html", "head", "head", "body"),
    mode = c(
      "empty", "open", "open", "close", "open"),
    level = c(0L, 0L, 1L, 1L, 1L),
    text = c(
      "<!DOCTYPE HTML>", "<html>", "<head>", "</head>", "<body>"))
}
rich-iannone/hyper documentation built on May 16, 2018, 11:24 a.m.