R/markdown.R
In jayhesselberth/pkgdown-search: Make Static HTML Documentation for a Package
Defines functions
markdown
markdown_text
markdown <- function(path = NULL, ..., strip_header = FALSE) {
tmp <- tempfile(fileext = ".html")
on.exit(file_delete(tmp), add = TRUE)
if (rmarkdown::pandoc_available("2.0")) {
from <- "markdown_github-hard_line_breaks+smart+auto_identifiers"
} else {
from <- "markdown_github-hard_line_breaks"
}
rmarkdown::pandoc_convert(
input = path,
output = tmp,
from = from,
to = "html",
options = purrr::compact(c(
if (!rmarkdown::pandoc_available("2.0")) "--smart",
if (rmarkdown::pandoc_available("2.0")) c("-t", "html4"),
"--indented-code-classes=R",
"--section-divs",
...
))
)
xml <- xml2::read_html(tmp, encoding = "UTF-8")
if (!inherits(xml, "xml_node")) {
stop(src_path(path), " must be non-empty", call. = FALSE)
}
# Capture heading, and optional remove
h1 <- xml2::xml_find_first(xml, ".//h1")
title <- xml2::xml_text(h1)
if (strip_header) {
xml2::xml_remove(h1)
}
tweak_code(xml)
tweak_md_links(xml)
tweak_anchors(xml, only_contents = FALSE)
# Extract body of html - as.character renders as xml which adds
# significant whitespace in tags like pre
xml %>%
xml2::xml_find_first(".//body") %>%
xml2::write_html(tmp, format = FALSE)
lines <- read_lines(tmp)
lines <- sub("<body>", "", lines, fixed = TRUE)
lines <- sub("</body>", "", lines, fixed = TRUE)
structure(
paste(lines, collapse = "\n"),
title = title
)
}
markdown_text <- function(text, ...) {
if (is.null(text))
return(text)
tmp <- tempfile()
on.exit(unlink(tmp), add = TRUE)
write_lines(text, path = tmp)
markdown(tmp, ...)
}
jayhesselberth/pkgdown-search documentation built on May 17, 2019, 9:12 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions markdown markdown_text
markdown <- function(path = NULL, ..., strip_header = FALSE) {
tmp <- tempfile(fileext = ".html")
on.exit(file_delete(tmp), add = TRUE)
if (rmarkdown::pandoc_available("2.0")) {
from <- "markdown_github-hard_line_breaks+smart+auto_identifiers"
} else {
from <- "markdown_github-hard_line_breaks"
}
rmarkdown::pandoc_convert(
input = path,
output = tmp,
from = from,
to = "html",
options = purrr::compact(c(
if (!rmarkdown::pandoc_available("2.0")) "--smart",
if (rmarkdown::pandoc_available("2.0")) c("-t", "html4"),
"--indented-code-classes=R",
"--section-divs",
...
))
)
xml <- xml2::read_html(tmp, encoding = "UTF-8")
if (!inherits(xml, "xml_node")) {
stop(src_path(path), " must be non-empty", call. = FALSE)
}
# Capture heading, and optional remove
h1 <- xml2::xml_find_first(xml, ".//h1")
title <- xml2::xml_text(h1)
if (strip_header) {
xml2::xml_remove(h1)
}
tweak_code(xml)
tweak_md_links(xml)
tweak_anchors(xml, only_contents = FALSE)
# Extract body of html - as.character renders as xml which adds
# significant whitespace in tags like pre
xml %>%
xml2::xml_find_first(".//body") %>%
xml2::write_html(tmp, format = FALSE)
lines <- read_lines(tmp)
lines <- sub("<body>", "", lines, fixed = TRUE)
lines <- sub("</body>", "", lines, fixed = TRUE)
structure(
paste(lines, collapse = "\n"),
title = title
)
}
markdown_text <- function(text, ...) {
if (is.null(text))
return(text)
tmp <- tempfile()
on.exit(unlink(tmp), add = TRUE)
write_lines(text, path = tmp)
markdown(tmp, ...)
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.