Nothing
# reset an environment using "objects" in a list
reset_env = function(x = list(), envir) {
rm(list = ls(envir, all.names = TRUE), envir = envir)
list2env(x, envir)
}
# counters for elements to be cross-referenced (e.g., fig, tab)
counters = local({
db = NULL
list(
get = function() db,
inc = function(name) db[[name]] <<- (db[[name]] %||% 0L) + 1L,
del = function(name) db <<- NULL
)
})
# use PCRE by default (which seems to handle multibyte chars better)
gregexpr = function(..., perl = TRUE) base::gregexpr(..., perl = perl)
attr = function(...) base::attr(..., exact = TRUE) # exact attr() please
`%|%` = function(x, y) if (length(x)) x else y
if (getRversion() < '4.4.0') `%||%` = function(x, y) if (is.null(x)) y else x
set_names = function(x, nm) {
names(x) = nm; x
}
dropNULL = function(x) x[!vapply(x, is.null, logical(1))]
# remove the <p> tag from HTML
sans_p = function(x) gsub('^<p[^>]*>|(</p>)?\n$', '', x)
# remove ugly single quotes, e.g., 'LaTeX' -> LaTeX
sans_sq = function(x) gsub("(^|\\W)'([^']+)'(\\W|$)", '\\1\\2\\3', x)
# remove YAML header (if title exists, convert it to h1)
sans_yaml = function(x) {
if (length(x) && grepl('^---\\s*?($|\n)', x[1])) {
res = xfun::yaml_body(split_lines(x))
x = c(if (is.character(t <- res$yaml$title)) paste('#', t), res$body)
}
x
}
split_chunk = function(...) xfun::divide_chunk(..., use_yaml = FALSE)
is_lang = function(x) is.symbol(x) || is.language(x)
uapply = function(..., recursive = TRUE) unlist(lapply(...), recursive = recursive)
.mapply = function(fun, ...) base::.mapply(fun, list(...), NULL)
#' Convert some ASCII strings to HTML entities
#'
#' Transform ASCII strings `(c)` (copyright), `(r)` (registered trademark),
#' `(tm)` (trademark), and fractions `n/m` into *smart* typographic HTML
#' entities.
#' @param text A character vector of the Markdown text.
#' @return A character vector of the transformed text.
#' @keywords internal
smartypants = function(text) {
text = split_lines(text)
i = prose_index(text)
r = '(?<!`)\\((c|r|tm)\\)|(\\d+/\\d+)(?!`)'
text[i] = match_replace(text[i], r, function(z) {
y = pants[z]
i = is.na(y)
y[i] = z[i]
y
})
text
}
# Represent some fractions with HTML entities
fracs = local({
n1 = c(
'1/2', '1/3', '2/3', '1/4', '3/4', '1/5', '2/5', '3/5', '4/5', '1/6', '5/6',
'1/8', '3/8', '5/8', '7/8'
)
n2 = c('1/7', '1/9', '1/10')
x2 = seq_along(n2) + 8527 # ⅐, 8529, 8530
set_names(c(sprintf('&frac%s;', gsub('/', '', n1)), sprintf('&#%d;', x2)), c(n1, n2))
})
pants = c(fracs, c('(c)' = '©', '(r)' = '®', '(tm)' = '™'))
# merge a later list in arguments into a former one by name
merge_list = function(...) {
dots = list(...)
res = dots[[1]]
for (i in seq_along(dots) - 1L) {
if (i == 0) next
x = dots[[i + 1]]
if (!is.list(x)) next
res[names(x)] = x
}
res
}
CHARS = c(letters, LETTERS, 0:9, '!', ',', '/', ':', ';', '=', '@')
# generate a random string that is not present in provided text
id_string = function(text, lens = c(5:10, 20), times = 20) {
for (i in lens) {
for (j in seq_len(times)) {
id = paste(sample(CHARS, i, replace = TRUE), collapse = '')
if (length(grep(id, text, fixed = TRUE)) == 0) return(id)
}
}
# failure should be very rare
stop('Failed to generate a unique ID string. You may try again.')
}
# a shorthand for gregexpr() and regmatches()
match_replace = function(x, r, replace = identity, ...) {
m = gregexpr(r, x, ...)
regmatches(x, m) = lapply(regmatches(x, m), function(z) {
if (length(z)) replace(z) else z
})
x
}
# gregexec() + regmatches() to greedy-match all substrings in regex groups
match_all = function(x, r, ...) {
regmatches(x, base::gregexec(r, x, ...))
}
# for R < 4.1.0
if (!exists('gregexec', baseenv(), inherits = TRUE)) match_all = function(x, r, ...) {
lapply(match_full(x, r, ...), function(z) {
if (length(z)) do.call(cbind, match_one(z, r, ...)) else z
})
}
# regexec() + regmatches() to match the regex once and capture substrings
match_one = function(x, r, ...) regmatches(x, regexec(r, x, ...))
# gregexpr() + regmatches() to match full strings but not substrings in regex groups
match_full = function(x, r, ...) regmatches(x, gregexpr(r, x, ...))
# if `text` is NULL and `input` is a file, read it; otherwise use the `text`
# argument as input
read_input = function(input, text) {
if (missing(input)) input = NULL
if (is.null(text)) {
if (is.null(input)) stop("Either 'input' or 'text' must be provided.")
text = if (is_file(input)) read_utf8(input) else input
}
structure(split_lines(text), input = if (is_file(input)) input)
}
# test if an input is a file path; if shouldn't be treated as file, use I()
is_file = function(x) {
length(x) == 1 && !inherits(x, 'AsIs') && is.character(x) &&
(file_ext(x) != '' || suppressWarnings(file_exists(x)))
}
is_output_file = function(x) {
is.character(x) && !(x %in% names(md_formats) || is_ext(x))
}
is_ext = function(x) grepl('^[.]', x) && sans_ext(x) == ''
# if output has an attribute full = TRUE
is_output_full = function(x) isTRUE(attr(x, 'full'))
# test if input is R code or not (this is based on heuristics and may not be robust)
is_R = function(input, text) {
if (is_file(input)) grepl('[.][Rrs]$', input) else {
!length(grep('^\\s*```+\\{', text)) && !try_error(parse_only(text))
}
}
# make an output filename with the format and input name
auto_output = function(input, output, format = NULL) {
# change NULL to a filename extension
if (is.null(output) && !is.null(format)) {
output = md_formats[format]
if (is.na(output)) stop(
"The output format '", format, "' is not supported (must be ",
xfun::join_words(names(md_formats), and = ' or ', before = "'"), ")."
)
}
# non-character `output` means the output shouldn't be written to a file
if (is.character(output)) {
if (startsWith(output, 'markdown:')) output = 'markdown'
# if `output` is an extension, make a full file path based on input
if (is_ext(output)) {
if (is_file(input)) output = with_ext(input, output)
}
if (is_file(input)) check_output(input, output)
}
output
}
# fall back to input path if output path is not available
output_path = function(input, output) {
if (is_output_file(output)) output else if (is_file(input)) input
}
# make sure not to overwrite input file inadvertently
check_output = function(input, output) {
if (file_exists(input) && same_path(input, output))
stop('The output file path is the same as input: ', input)
output
}
# substitute a variable in template `x` with its value; the variable may have
# more than one possible name, in which case we try them one by one
sub_var = function(x, name, value, ...) {
for (i in name) {
if (any(grepl(i, x, fixed = TRUE))) {
return(sub(i, one_string(value, ...), x, fixed = TRUE))
}
}
x
}
# unescape HTML code
restore_html = function(x) {
x = gsub('"', '"', x, fixed = TRUE)
x = gsub('&', '&', x, fixed = TRUE)
x = gsub('<', '<', x, fixed = TRUE)
x = gsub('>', '>', x, fixed = TRUE)
x
}
#' Add CSS/JS assets to HTML output
#'
#' While CSS/JS assets can be set via the `css`/`js` keys under the `meta` field
#' of the `html` output format in YAML, this function provides another way to
#' add them, which can be called in a code chunk to dynamically add assets.
#' @param feature A character vector of features supported by CSS/JS, e.g.,
#' `c('article', 'callout')`. See the row names of `litedown:::assets` for all
#' available features. Each feature will be mapped to CSS/JS.
#' @param css,js Character vectors of CSS/JS assets.
#' @return A vector of `<link>` (CSS) or `<script>` (JS) tags.
#' @export
#' @examples
#' litedown:::assets[, -1]
#' # add features
#' litedown::vest(c('copy-button', 'tabsets'))
#' # add css/js directly
#' litedown::vest(css = '@tabsets', js = c('@tabsets', '@fold-details'))
vest = function(feature = NULL, css = NULL, js = NULL) {
if (length(feature)) {
a = assets[feature, , drop = FALSE]
css = c(a[, 'css'], css); js = c(a[, 'js'], js)
}
new_asis(c(resolve_files(css, 'css'), resolve_files(js, 'js')), raw = TRUE)
}
assets = t(data.frame(
article = c('side notes, floats, and full-width elements for articles', '@article', '@sidenotes, @appendix'),
book = c('cover and chapter pages for books', '@book', NA),
callout = c('frames with legends', '@callout', '@callout'),
'center-img' = c('center images in paragraphs', NA, '@center-img'),
'chapter-toc' = c('add TOC to each chapter', NA, '@chapter-toc'),
'copy-button' = c('copy buttons', '@copy-button', '@copy-button'),
default = c('default CSS', '@default', NA),
'external-link' = c('open external links in new windows', NA, '@external-link'),
'fold-details' = c('fold elements (e.g., code blocks)', NA, '@fold-details'),
'heading-anchor' = c('add anchor links to headings', '@heading-anchor', '@heading-anchor'),
'key-buttons' = c('style keyboard shortcuts', '@key-buttons', '@key-buttons'),
pages = c('paginate HTML for printing', '@pages', '@pages'),
'right-quote' = c('right-align quote footers', NA, '@right-quote'),
snap = c('snap slides', '@snap', '@snap'),
tabsets = c('create tabsets from bullet lists or sections', '@tabsets', '@tabsets'),
'toc-highlight' = c('highlight TOC items on scroll', NA, '@toc-highlight'),
row.names = c('description', 'css', 'js'), check.names = FALSE
))
# an HTML form for creating new files in roam()
feature_form = function(path) {
nms = rownames(assets)
files = list.files(if (dir.exists(path)) path else dirname(path), full.names = TRUE)
files = basename(files[file_exists(files)])
one_string(c(
'<h3>New File</h3>',
'<p><label>Filename: <input type="text" id="filename-input" list="file-list" placeholder="enter a new filename (not in the list)" /></label></p>',
if (length(files)) c(
'<datalist id="file-list">',
sprintf('<option value="❌ %s">', html_escape(files, TRUE)),
'</datalist>'
),
'<p><b>Select HTML features</b></p>', '<p style="columns:20em;">',
sprintf(
'<label><input name="%s" type="checkbox" /> <a href="https://yihui.org/litedown/#sec:%s" target="_blank"><code>%s</code></a>: %s</label>',
nms, nms, nms, html_escape(assets[, 'description'])
), '</p>'
))
}
na_omit = function(x) x[!is.na(x)]
# accumulate variable values
acc_var = local({
db = list()
function(...) {
v = list(...)
if (is.null(nms <- names(v))) {
v = unlist(v)
switch(length(v) + 1, db <<- list(), db[[v]], db[v])
} else {
for (i in nms) db[[i]] <<- c(db[[i]], v[[i]])
}
}
})
# set js/css variables according to the js_math option
set_math = function(o, is_katex) {
if (is_katex) o$js = c(o$js, 'dist/contrib/auto-render.min.js')
js = js_combine(sprintf('npm/%s%s/%s', o$package, o$version, o$js))
js = if (is_katex) c(js, '@render-katex') else c('@mathjax-config', js)
css = sprintf('@npm/%s%s/%s', o$package, o$version, o$css)
acc_var(js = js, css = css)
}
# use jsdelivr's combine feature
js_combine = function(...) {
if (length(x <- c(...))) paste0('@', paste(x, collapse = ','))
}
js_options = function(x, default) {
d = js_default(x, default)
x = if (is.list(x)) merge_list(d, x) else d
if (length(x) == 0) return()
if (x$version != '') x$version = sub('^@?', '@', x$version)
x
}
js_default = function(x, default) {
if (is.list(x)) x = x$package
if (is.null(x) || isTRUE(x)) x = default
if (is.character(x)) merge_list(js_libs[[x]], list(package = x))
}
js_libs = list(
highlight = list(
version = '11.7.0', style = 'xcode', js = 'build/highlight.min.js'
),
katex = list(version = '', css = 'dist/katex.min.css', js = 'dist/katex.min.js'),
mathjax = list(version = '3', js = 'es5/tex-mml-chtml.js'),
prism = list(
version = '1.29.0', js = 'components/prism-core.min.js'
)
)
# set js/css variables according to the js_highlight option
set_highlight = function(options, html) {
# if the class .line-numbers is present, add js/css for line numbers
if (any(grepl('<code class="[^"]*line-numbers', html)))
acc_var(js = '@code-line-numbers', css = '@code-line-numbers')
r = '(?<=<code class="language-)([^"]+)(?=")'
if (!any(grepl(r, html, perl = TRUE))) return()
if (!length(o <- js_options(options[['js_highlight']], 'prism'))) return()
p = o$package
# return jsdelivr subpaths
get_path = function(path) {
t = switch(
p, highlight = 'gh/highlightjs/cdn-release%s/%s', prism = 'npm/prismjs%s/%s'
)
sprintf(t, o$version, path)
}
# add the `prism-` prefix if necessary
normalize_prism = function(x) {
if (length(x) == 1 && x == 'prism') x else sub('^(prism-)?', 'prism-', x)
}
# if resources need to be embedded, we need to work harder to figure out which
# js files to embed (this is quite tricky and may not be robust)
embed = ('https' %in% options[['embed_resources']]) || is.character(options[['offline']])
# style -> css
css = c(if (is.null(s <- o$style)) {
if (p == 'prism') '@prism-xcode' # use prism-xcode.css in the lite.js repo
} else if (is.character(s)) js_combine(get_path(switch(
p,
highlight = sprintf('build/styles/%s.min.css', s),
prism = sprintf('themes/%s.min.css', normalize_prism(s))
))))
# languages -> js
get_lang = function(x) switch(
p,
highlight = sprintf('build/languages/%s.min.js', x),
prism = sprintf('components/%s.min.js', normalize_prism(x))
)
autoloader = 'plugins/autoloader/prism-autoloader.min.js'
o$js = c(o$js, if (!is.null(l <- o$languages)) get_lang(l) else {
# detect <code> languages in html and load necessary language components
lang = unlist(match_full(html, r))
lang = gsub(' .*', '', lang) # only use the first class name
lang = setdiff(lang, 'plain') # exclude known non-existent names
f = switch(p, highlight = js_libs[[c(p, 'js')]], prism = autoloader)
if (!embed && p == 'prism') f else {
get_lang(lang_files(p, get_path(f), lang))
}
})
js = get_path(o$js)
if (p == 'highlight') js = c(js, 'npm/@xiee/utils/js/load-highlight.js')
# do not combine js when they are automatically detected (this will make
# embedding faster because each js is a separate URL that has been downloaded)
js = if (is.null(l)) paste0('@', js) else js_combine(js)
acc_var(js = js, css = css)
}
# figure out which language support files are needed for highlight.js/prism.js
lang_files = function(package, path, langs) {
u = jsdelivr(path, '')
x = download_cache$get(u, 'text')
x = one_string(x)
warn = function(l1, l2, url) warning(
"Unable to recognize code blocks with language(s): ", comma_list(l2),
". They will not be syntax highlighted by ", package, ".js. If you can find ",
"the right language files at ", url, ", you may mannually specify their names ",
"in the 'languages' field of the 'js_highlight' option.",
if (length(l1)) c(" Also remember to add ", comma_list(l1))
)
if (package == 'highlight') {
# first figure out all languages bundles in highlight.js (starting with grmr_)
x = unlist(strsplit(x, ',\n?grmr_'))
r = '^([[:alnum:]_-]+):.+'
x = grep(r, x, value = TRUE)
l = gsub(r, '\\1', x)
# then find their aliases
a = lapply(match_full(x, '(?<=aliases:\\[)[^]]+(?=\\])'), function(z) {
z = unlist(strsplit(z, '[",]'))
z[!is_blank(z)]
})
l = c(l, unlist(a)) # all possible languages that can be highlighted
l = setdiff(langs, l) # languages not supported by default
if (length(l) == 0) return()
# check if language files exist on CDN
d = paste0(dirname(u), '/languages/')
l1 = uapply(l, function(z) {
if (downloadable(sprintf('%s%s.min.js', d, z))) z
})
l2 = setdiff(l, l1)
if (length(l2)) warn(l1, l2, d)
l1
} else {
# dependencies and aliases (the arrays should be more than 1000 characters)
x = unlist(match_full(x, '(?<=\\{)([[:alnum:]_-]+:\\[?"[^}]{1000,})(?=\\})'))
if (length(x) < 2) {
warning(
"Unable to process Prism's autoloader plugin (", u, ") to figure out ",
"language components automatically. Please report this message to ",
packageDescription('litedown')$BugReports, "."
)
return()
}
x = x[1:2]
x = lapply(match_full(x, '([[:alnum:]_-]+):(\\["[^]]+\\]|"[^"]+")'), function(z) {
z = gsub('[]["]', '', z)
uapply(strsplit(z, '[:,]'), function(y) {
set_names(list(y[-1]), y[1])
}, recursive = FALSE)
})
# x1 is dependencies; x2 is aliases
x1 = x[[1]]; x2 = unlist(x[[2]])
# normalize aliases to canonical names
i = langs %in% names(x2)
langs[i] = x2[langs[i]]
# resolve dependencies via recursion
resolve_deps = function(lang) {
deps = x1[[lang]]
c(lapply(deps, resolve_deps), lang)
}
# all languages required for this page
l1 = unique(uapply(langs, resolve_deps))
# languages that are officially supported
l2 = c(names(x1), unlist(x1), x2)
# for unknown languages, check if they exist on CDN
d = sub('/plugins/.+', '/components/', u)
l3 = uapply(setdiff(l1, l2), function(z) {
if (!downloadable(sprintf('%sprism-%s.min.js', d, z))) z
})
l4 = setdiff(l1, l3)
if (length(l3)) warn(l4, l3, d)
l4
}
}
# test if a URL can be downloaded
downloadable = function(u, type = 'text') {
!try_error(download_cache$get(u, type))
}
# quote a vector and combine by commas
comma_list = function(x) paste0('"', x, '"', collapse = ', ')
# get an option specific to an output format
get_option = function(name, format, ...) {
getOption(sprintf('litedown.%s.%s', format, name), ...)
}
# if a string is a file path found under test dirs, read the file; then concatenate elements by \n
one_string = function(x, by = '\n', test = NULL) {
if (length(test) && is_file(x)) {
p = if (is_abs_path(x)) x else xfun::existing_files(file.path(c(test, '.'), x))
if (length(p)) x = read_utf8(p[1]) else stop("The file '", x, "' is not found")
}
paste(x, collapse = by)
}
# find @citation and resolve references
add_citation = function(x, bib, format = 'html') {
if (!format %in% c('html', 'latex')) return(x)
bib = do.call(c, lapply(bib, rbibutils::readBib, direct = TRUE, texChars = 'convert'))
if (length(bib) == 0) return(x)
cited = NULL
is_html = format == 'html'
r = if (is_html) '(?<!<code>)(\\[@[-;@ [:alnum:]]+\\]|@[-[:alnum:]]+)' else
'(?<!\\{)(\\{\\[\\}@[-;@ [:alnum:]]+\\{\\]\\}|@[-[:alnum:]]+)'
# [@key] for citep, and @key for citet
x = match_replace(x, r, function(z) {
z2 = uapply(strsplit(z, '[;@ {}]+'), function(keys) {
bracket = any(grepl('^\\[', keys))
if (bracket) keys = gsub('^\\[|\\]$', '', keys)
keys = keys[keys != '']
if (length(keys) == 0 || !all(keys %in% names(bib))) return(NA)
if (is_html) {
cited <<- c(cited, keys)
cite_html(keys, bib, bracket)
} else {
sprintf('\\cite%s{%s}', if (bracket) 'p' else 't', one_string(keys, ','))
}
})
ifelse(is.na(z2), z, z2)
})
if (is_html) {
b = bib_html(bib, cited)
d = '<div id="refs">'
if (any(grepl(d, x, fixed = TRUE))) {
x = sub(d, paste0(d, one_string(b)), x, fixed = TRUE)
} else {
x = one_string(c(x, d, b, '</div>'))
}
}
x
}
# fall back to given name if family name is empty
author_name = function(x) {
a = paste(x$family %|% x$given, collapse = ' ')
a = gsub('\\{\\\\(.)}', '\\1', a) # un-escape special latex chars
html_escape(a)
}
# mimic natbib's author-year citation style for HTML output
cite_html = function(keys, bib, bracket = TRUE) {
x = NULL; N = length(keys)
for (i in seq_len(N)) {
key = keys[i]; b = bib[[key]]; a = b$author; n = length(a)
z = paste0(c(
author_name(a[[1]]),
if (n == 2) c('<span class="ref-and"></span>', author_name(a[[2]])),
if (n > 2) '<span class="ref-et-al"></span>', ' ',
if (bracket) b$year else
c('<span class="ref-paren-open ref-paren-close">', b$year, '</span>')
), collapse = '')
cls = if (bracket) c(
if (i == 1) 'ref-paren-open', if (i == N) 'ref-paren-close',
if (i < N) 'ref-semicolon'
)
z = cite_link(key, z, one_string(c('', cls), ' '))
x = c(x, z)
}
one_string(x, '')
}
cite_link = function(key, text, class = '') {
sprintf('<a href="#ref-%s" class="citation%s">%s</a>', key, class, text)
}
# html bibliography
bib_html = function(bib, keys) {
bib = sort(bib[unique(keys)])
keys = uapply(bib, function(x) attr(unclass(x)[[1]], 'key'))
res = format(bib, 'html')
paste0('<p id="ref-', keys, '"', sub('^<p', '', res))
}
# add meta variables bib-preamble and bib-end for LaTeX output
bib_meta = function(meta, bib, package) {
bib = one_string(bib, ',')
if (is.null(meta[['bib-preamble']])) meta[['bib-preamble']] = switch(
package,
none = '\\bibliographystyle{apalike}\\let\\citep\\cite\\let\\citet\\cite',
natbib = '\\usepackage{natbib}\\bibliographystyle{abbrvnat}',
biblatex = paste0(
'\\usepackage[style=authoryear]{biblatex}\\addbibresource{', bib,
'}\\let\\citep\\parencite\\let\\citet\\cite'
)
)
if (is.null(meta[['bib-end']])) meta[['bib-end']] = if (package == 'biblatex')
'\\printbibliography' else paste0('\\bibliography{', bib, '}')
meta
}
# find headings and build a table of contents as an unordered list
build_toc = function(html, n = 3) {
if (n <= 0) return()
if (n > 6) n = 6
r = sprintf('<(h[1-%d])( id="[^"]+")?[^>]*>(.+?)</\\1>', n)
items = unlist(match_full(html, r))
# ignore headings with class="unlisted"
items = items[!has_class(items, 'unlisted')]
if (length(items) <= 1) return() # require at least 2 items in TOC
x = gsub(r, '<toc\\2>\\3</toc>', items) # use a tag <toc> to protect heading text
x = gsub('<a[^>]+>|</a>', '', x) # clean up <a>
h = as.integer(gsub('^h', '', gsub(r, '\\1', items))) # heading level
s = strrep(' ', seq_len(n) - 1) # indent
x = paste0(s[h], '- ', x) # create an unordered list
x = commonmark::markdown_html(x)
# add anchors on TOC items
x = gsub('<toc id="([^"]+)">(.+?)</toc>', '<a href="#\\1">\\2</a>', x)
x = gsub('</?toc>', '', x)
# add class 'numbered' to the first <ul> if any heading is numbered
if (length(grep('<span class="section-number[^"]*">', x)))
x = sub('<ul>', '<ul class="numbered">', x)
paste0('<div id="TOC">\n', x, '</div>')
}
# add TOC to the html body
add_toc = function(html, options) {
o = options[['toc']]
if (is.null(o) || isFALSE(o)) return(html)
if (isTRUE(o)) o = list()
if (!is.numeric(o$depth)) o$depth = 3
one_string(c(build_toc(html, o$depth), html))
}
sec_levels = c('subsubsection', 'subsection', 'section', 'chapter', 'part')
# raise section levels: redefine section to chapter or part, and so on
redefine_level = function(x, top) {
n = switch(top, chapter = 1, part = 2, 0)
if (n == 0) return(x)
for (i in 3:1) {
x = gsub(sprintf('(^|\n)\\\\%s', sec_levels[i]), sprintf('\\\\%s', sec_levels[i + n]), x)
}
x
}
# move image attributes like `![](){#id .class width="20%"}`, heading attributes
# `# foo {#id .class}`, and fenced Div's `::: {#id .class}` into HTML tags and
# LaTeX commands
move_attrs = function(x, format = 'html') {
if (format == 'html') {
# images
x = convert_attrs(x, '(<img src="[^>]+ )/>\\{([^}]+)\\}', '\\2', function(r, z, z2) {
z1 = sub(r, '\\1', z)
paste0(z1, z2, ' />')
})
# headings
x = convert_attrs(x, '(<h[1-6])(>.+?) \\{([^}]+)\\}(</h[1-6]>)', '\\3', function(r, z, z3) {
z1 = sub(r, '\\1 ', z)
z24 = sub(r, '\\2\\4', z)
paste0(z1, z3, z24)
})
# links
x = convert_attrs(x, '(<a[^>]+)(>(?s).*?</a>)(\\{([^}]+)\\})?', '\\4', function(r, z, z3) {
z1 = sub(r, '\\1', z, perl = TRUE)
z2 = sub(r, '\\2', z, perl = TRUE)
paste0(z1, ifelse(z3 == '', '', ' '), z3, z2)
})
# fenced Div's
x = convert_attrs(x, '<p>:::+ \\{(.*?)\\}</p>', '\\1', function(r, z, z1) {
# add attributes to the div but remove the data-latex attribute
z1 = str_trim(gsub('(^| )data-latex="[^"]*"( |$)', ' ', z1))
sprintf('<div%s%s>', ifelse(z1 == '', '', ' '), z1)
})
x = gsub('<p>:::+</p>', '</div>', x)
} else if (format == 'latex') {
# only support image width
x = convert_attrs(x, '(\\\\includegraphics)(\\{[^}]+\\})\\\\\\{([^}]+)\\\\\\}', '\\3', function(r, z, z3) {
r2 = '(^|.* )width="([^"]+)"( .*|$)'
j = grepl(r2, z3)
w = gsub(r2, '\\2', z3[j])
w = gsub('\\\\', '\\', w, fixed = TRUE)
k = grep('%$', w)
w[k] = paste0(as.numeric(sub('%$', '', w[k])) / 100, '\\linewidth')
z3[j] = paste0('[width=', w, ']')
z3[!j] = ''
z1 = sub(r, '\\1', z)
z2 = sub(r, '\\2', z)
paste0(z1, z3, z2)
}, format)
# discard most attributes for headings
r = sprintf('(\\\\(%s)\\{.+?) \\\\\\{([^}]+)\\\\\\}(\\})', paste(sec_levels, collapse = '|'))
x = convert_attrs(x, r, '\\3', function(r, z, z3) {
z = gsub(r, '\\1\\4', z)
k = has_class(z3, 'unnumbered')
z[k] = sub('{', '*{', z[k], fixed = TRUE)
k = has_class(z3, 'appendix')
z[k] = '\\appendix'
r2 = '(^|.* )id="([^"]+)".*'
k = grepl(r2, z3)
id = gsub(r2, '\\2', z3[k])
z[k] = paste0(z[k], '\\label{', id, '}')
z
}, format)
# fenced Div's: first class name is the environment name; options from data-latex
r = '\n\\\\begin\\{verbatim\\}\n(:::+)( \\{([^\n]+?)\\})? \\1\n\\\\end\\{verbatim\\}\n'
x = convert_attrs(x, r, '\\3', function(r, z, z3) {
r1 = '(^|.*? )class="([^" ]+)[" ].*'
r2 = ' data-latex="([^"]*)".*$'
r3 = paste0(r1, '?', r2)
i3 = grepl(r3, z3)
z4 = ifelse(i3, gsub(r3, '{\\2}\\3', z3), ifelse(z3 == '', '', '{@}'))
cls = gsub(r1, '\\2', z3)
# fig/tab environments don't need the data-latex attribute
i4 = !i3 & cls %in% c('figure', 'caption', 'table')
z4[i4] = sprintf('{%s}', cls[i4])
z3 = latex_envir(gsub('\\\\', '\\', z4, fixed = TRUE))
z3[z3 %in% c('\\begin{@}', '\\end{@}')] = ''
i = grep('^\\\\begin', z3)
z3[i] = paste0('\n', z3[i])
i = grep('^\\\\end', z3)
z3[i] = paste0(z3[i], '\n')
# put fig/tab captions in \caption{}
z3 = gsub('\\begin{caption}', '\\caption{', z3, fixed = TRUE)
z3 = gsub('\\end{caption}', '}', z3, fixed = TRUE)
z3
}, format)
# remove table env generated from commonmark and use those from fenced Divs
x = gsub('\\\\begin\\{table\\}\n(?=\\\\begin\\{tabular\\})', '', x, perl = TRUE)
x = gsub('(?<=\\\\end\\{tabular\\}\n)\\\\end\\{table}', '', x, perl = TRUE)
} else {
# TODO: remove attributes for other formats
}
x
}
convert_attrs = function(x, r, s, f, format = 'html', f2 = identity) {
r2 = '(?<=^| )[.#]([-:[:alnum:]]+)(?= |$)' # should we allow other chars in ID/class?
match_replace(x, r, function(y) {
z = sub(r, s, y, perl = TRUE)
if (format == 'html') {
z = gsub('[\U201c\U201d]', '"', z)
} else {
z = gsub('=``', '="', z, fixed = TRUE)
z = gsub("''( |\\\\})", '"\\1', z)
z = gsub('\\\\([#%])', '\\1', z)
}
z2 = f2(z)
# {-} is a shorthand of {.unnumbered}
z2[z2 == '-'] = '.unnumbered'
# convert #id to id="" and .class to class=""
z2 = match_replace(z2, r2, function(a) {
i = grep('^[.]', a)
if ((n <- length(i))) {
# merge multiple classes into one class attribute
a[i] = sub('^[.]', '', a[i])
a[i] = c(sprintf('class="%s"', paste(a[i], collapse = ' ')), rep('', n - 1))
a = c(a[i], a[-i])
}
if (length(i <- grep('^#', a))) {
a[i] = gsub(r2, 'id="\\1"', a[i], perl = TRUE)
a = c(a[i], a[-i]) # make sure id is the first attribute
}
a
})
# remove spaces after class="..." (caused by merging multiple classes)
z2 = sub('(^| )(class="[^"]+") +', '\\1\\2 ', z2)
f(r, y, str_trim(z2))
})
}
str_trim = function(x) gsub('^\\s+|\\s+$', '', x)
# trim blank lines from both ends
trim_blank = function(x) gsub('^(\\s*\n)+|\n\\s*$', '', x)
# {A}, '', {B}, {C}, '', '' -> \begin{A}\end{A}\begin{B}\begin{C}\end{C}\end{B}
latex_envir = function(x, env = NULL) {
n = length(x)
if (n == 0) return()
x1 = x[1]
env2 = tail(env, 1) # the most recent env is in the end
env = if (x1 == '') head(env, -1) else c(env, sub('^(\\{[^}]+}).*$', '\\1', x1))
c(if (x1 == '') paste0('\\end', env2) else paste0('\\begin', x1), latex_envir(x[-1], env))
}
# find and render footnotes for LaTeX output
render_footnotes = function(x) {
f1 = f2 = NULL
# [^1] is converted to {[}\^{}1{]}
r = '(\n\n)(\\{\\[}\\\\\\^\\{}[0-9]+\\{\\]}): (.*?)\n(\n|$)'
x = match_replace(x, r, function(z) {
f1 <<- c(f1, sub(r, '\\2', z))
f2 <<- c(f2, sub(r, '\\3', z))
gsub(r, '\\1', z)
}, perl = FALSE)
for (i in seq_along(f1)) {
x = sub(f1[i], sprintf('\\footnote{%s}', f2[i]), x, fixed = TRUE)
}
x
}
# add auto identifiers to headings
auto_identifier = function(x) {
r = '<(h[1-6])([^>]*)>(.+?)</\\1>'
match_replace(x, r, function(z) {
z1 = sub(r, '\\1', z) # tag
z2 = sub(r, '\\2', z) # attrs
z3 = sub(r, '\\3', z) # content
i = !grepl(' id="[^"]*"', z2) # skip headings that already have IDs
p = ifelse(z1 == 'h1', 'chp:', 'sec:') # h1 is chapter; h2+ are sections
id = unique_id(paste0(p[i], alnum_id(z3[i])), 'section')
z[i] = sprintf('<%s id="%s"%s>%s</%s>', z1[i], id, z2[i], z3[i], z1[i])
z
})
}
# add a number suffix to an id if it is duplicated
unique_id = function(x, empty) {
x[x == ''] = empty
i = duplicated(x)
for (d in unique(x[i])) {
k = x == d
x[k] = paste0(x[k], '_', seq_len(sum(k)))
}
x
}
# test if a class name exists in attributes
has_class = function(x, class) {
grepl(sprintf('(^| )class="([^"]+ )?%s( [^"]+)?"', class), x)
}
# number sections in HTML output
number_sections = function(x) {
h = sub('</h([1-6])>', '\\1', unlist(match_full(x, '</h[1-6]>')))
if (length(h) == 0) return(x) # no headings
h = min(as.integer(h)) # highest level of headings
r = '<h([1-6])([^>]*)>(?!<span class="section-number)'
n = rep(0, 6) # counters for all levels of headings
# when previewing a book chapter, set the start number if possible
is_appendix = FALSE # the start "number" for appendix is A-Z
if (length(f <- .env$current_file)) {
if (length(n_start <- grep_sub('^([0-9]+|[A-Z])[-_].+', '\\1', basename(f))))
if (!(is_appendix <- grepl('^[A-Z]$', n_start))) n[1] = as.integer(n_start) - 1
}
k0 = 6 # level of last unnumbered heading
match_replace(x, r, function(z) {
z1 = as.integer(sub(r, '\\1', z, perl = TRUE)) # heading levels
z2 = sub(r, '\\2', z, perl = TRUE) # heading attributes
num_sections = identity # generate appendix numbers
for (i in seq_along(z)) {
k = z1[i]
if (k < 6) n[(k + 1):6] <<- 0
# skip unnumbered sections
if (has_class(z2[i], 'unnumbered')) {
k0 <<- k; next
} else {
# don't number headings with level lower than last unnumbered heading
if (k > k0) next else k0 <<- 6
}
if (has_class(z2[i], 'appendix')) {
if (k != h) stop(
"The 'appendix' attribute must be on the top-level heading (",
strrep('#', h), ').'
)
num_sections = local({
a = n[k] # an offset (highest top-level heading number before appendix)
# number headings with A-Z or roman numerals
num = if (sum(z1[i:length(z)] == h) - 1 > 26) as.roman else {
function(i) LETTERS[i]
}
function(s) {
if (s[1] <= a) stop(
'An appendix section must start with the top-level heading (',
strrep('#', h), ').'
)
s[1] = num(s[1] - a)
s
}
})
next
}
n[k] <<- n[k] + 1
# remove leading 0's
s = if (h > 1) n[-(1:(h - 1))] else n
if (is_appendix) s[1] = n_start else s = num_sections(s)
s = paste(s, collapse = '.')
s = gsub('([.]0)+$', '', s) # remove trailing 0's
# if section number doesn't contain '.', assign a class 'main-number' to the number
z[i] = paste0(z[i], sprintf(
'<span class="section-number%s">%s</span> ',
ifelse(grepl('[.]', s), '', ' main-number'), s
))
}
z
})
}
# number elements such as headings and figures, etc and resolve cross-references
number_refs = function(x, r, katex = TRUE) {
if (length(x) == 0) return(x)
db = list() # element numbers
# first, find numbered section headings
r2 = '<h[1-6][^>]*? id="([^"]+)"[^>]*><span class="section-number[^"]*">([0-9.]+)</span>'
m = match_all(x, r2)[[1]]
if (length(m)) {
ids = m[2, ]
db = as.list(set_names(m[3, ], ids))
}
# retrieve refs from all chapters for fuse_book()
if (is.character(b <- .env$current_book)) db = merge_list(.env$refs[[b]], db)
# then find and number other elements
r2 = sprintf('<a href="#@%s"> ?</a>', r)
db2 = list()
x = match_replace(x, r2, function(z) {
type = sub(r2, '\\2', z)
id = sub(r2, '\\1', z)
ids = split(id, type)
db2 <<- unlist(unname(lapply(ids, function(id) set_names(seq_along(id), id))))
sprintf('<span class="ref-number-%s">%d</span>', type, db2[id])
})
db = unlist(if (is.character(b)) merge_list(db, as.list(db2)) else c(db, db2))
ids = names(db)
if (any(i <- duplicated(ids))) warning('Duplicated IDs: ', one_string(ids[i], ', '))
# save refs db for fuse_book()
if (is.character(b)) .env$refs[[b]] = db
# finally, resolve cross-references
r2 = sprintf('<a href="#(%s)">@\\1</a>', r)
match_replace(x, r2, function(z) {
type = sub(r2, '\\3', z)
id = sub(r2, '\\2', z)
# equation numbers will be resolved in JS later
i1 = grepl('^eq[-:]', id)
z[i1] = sprintf('\\ref{%s}', id[i1])
i2 = grepl('^eqn[-:]', id)
z[i2] = sprintf('\\eqref{%s}', sub('eqn', 'eq', id[i2]))
i3 = i1 | i2
# KaTeX requires references to be in math, e.g., \(\ref{ID}\)
if (katex) z[i3] = paste0('\\(', z[i3], '\\)')
i = id %in% ids
# for backward compatibility, if fig-id is not found, also look for fig:id
if (any(i4 <- !i & !i3)) {
id2 = sub('-', ':', id)
j = i4 & (id2 %in% ids)
id[j] = id2[j]; i[j] = TRUE; i4[j] = FALSE
}
if (any(i)) z[i] = sprintf(
'<a class="cross-ref-%s" href="#%s">%s</a>', type[i], id[i], db[id[i]]
)
if (any(i4)) warning('Reference key(s) not found: ', one_string(id[i4], ', '))
z
})
}
# add a special anchor [](#@id) to text, to be used to resolved cross-references
add_ref = function(id, type, x = NULL) {
c(sprintf('[](#@%s:%s)', type, id), x)
}
# make cross-refs for LaTeX output, to be resolved by a LaTeX engine
latex_refs = function(x, r, clever = FALSE) {
ar = paste0('@', r)
r0 = function(a, b) sprintf('\\\\protect\\\\hyperlink\\{%s\\}\\{%s\\}', a, b)
r1 = r0(ar, '\\s*') # \label{}
r2 = r0(r, ar) # \ref{}
x = gsub(r1, '\\\\label{\\1}', x)
x = gsub(r2, sprintf('\\\\%sref{\\1}', if (clever) 'c' else ''), x)
x
}
embed_resources = function(x, options) {
if (length(x) == 0) return(x)
r = '\n<link[^>]*? rel="stylesheet" [^>]*>|\n<script[^>]*? src="[^"]+"[^>]*>\\s*</script>'
x2 = NULL # to be appended to <head>
x = match_replace(x, r, function(z) {
# de-dup assets (e.g., when vest() is called multiple times on the same asset)
z[duplicated(z)] = ''
i = grep(' defer(>| ).*</script>$', z)
x2 <<- c(x2, z[i])
z[i] = ''
z
})
# move deferred scripts to the end of <head>
if (length(x2)) {
x = if (length(grep('</head>', x)) != 1) {
one_string(c(x2, x))
} else {
match_replace(x, '</head>', fixed = TRUE, perl = FALSE, function(z) {
one_string(c(x2, z))
})
}
}
embed = c('https', 'local') %in% options[['embed_resources']]
offline = options[['offline']]
if (!any(embed, is.character(offline))) return(x)
clean = options[['embed_cleanup']]
# find images in <img> and (for slides only) comments
rs = c(
'(<img src=")([^"]+)("[^>]*?/>)',
'(<!--#[^>]*? style="background-image: url\\("?)([^"]+?)("?\\);)'
)
for (r in rs) x = match_replace(x, r, function(z) {
z1 = sub(r, '\\1', z)
z2 = sub(r, '\\2', z)
z3 = sub(r, '\\3', z)
# skip images already base64 encoded
for (i in grep('^data:.+;base64,.+', z2, invert = TRUE)) {
is_svg = grepl('[.]svg$', f <- z2[i]) && grepl('^<img', z1[i])
a = if (is_svg) str_trim(gsub('^"|/>$', '', z3[i])) else ''
f = download_url(f, offline)
if (is_https(f)) {
if (embed[1]) z2[i] = if (!is_svg) download_cache$get(f, 'base64') else {
download_cache$get(f, 'text', function(xml) process_svg(xml, a))
}
} else if (embed[2]) {
if (file_exists(f <- URLdecode(f))) {
z2[i] = if (is_svg) process_svg(read_utf8(f), a) else base64_uri(f)
if (clean && normalize_path(f) %in% .env$plot_files) file.remove(f)
} else {
warning("File '", f, "' not found (hence cannot be embedded).")
}
}
}
ifelse(grepl('<svg', z2), z2, paste0(z1, z2, z3))
})
# CSS and JS
r = paste0(
'<link[^>]*? rel="stylesheet" href="([^"]+)"[^>]*>|',
'<script([^>]*?) src="([^"]+)"([^>]*)>\\s*</script>'
)
match_replace(x, r, function(z) {
z1 = sub(r, '\\1', z) # css
z2 = sub(r, '\\3', z) # js
js = z2 != ''
z3 = paste0(z1, z2)
# skip resources already base64 encoded
i1 = !grepl('^data:.+;base64,.+', z3)
z3[i1] = gen_tags(
z3[i1], ifelse(js[i1], 'js', 'css'), embed[1], embed[2], offline,
sub(r, '\\2\\4', z) # attributes for js
)
z3
})
}
# remove the xml/doctype declaration in svg, and add attributes
process_svg = function(x, attr) {
while (length(x) > 0 && !grepl('^\\s*<svg .+', x[1])) x = x[-1]
if (length(x) > 0 && !attr %in% c('', 'alt=""')) {
x[1] = if (grepl(r <- '\\s*>\\s*$', x[1])) {
paste0(gsub(r, ' ', x[1]), attr, '>')
} else {
paste(x[1], attr)
}
}
one_string(x)
}
normalize_options = function(x, format = 'html') {
g = get_option('options', format)
x = option2list(x)
n = names(x)
# default options
d = option2list(markdown_options())
g = option2list(g)
d[names(g)] = g # merge global options() into default options
d[n] = x # then merge user-provided options
if (!is.character(d[['top_level']])) d$top_level = 'section'
if (isTRUE(o <- d[['offline']])) o = 'assets'
if (!is.character(o)) o = FALSE
d$offline = o
d = normalize_embed(d)
# TODO: fully enable footnotes https://github.com/github/cmark-gfm/issues/314
if (format == 'html' && !is.logical(d[['footnotes']])) d$footnotes = TRUE
d
}
normalize_embed = function(x) {
v = x[['embed_resources']]
if (is.logical(v)) {
v = if (v) 'local'
} else {
if (length(v) == 1 && v == 'all') v = c('local', 'https')
}
x[['embed_resources']] = v
x
}
named_bool = function(x, val = TRUE) as.list(set_names(rep(val, length(x)), x))
# normalize metadata variable names: change _ to -
normalize_meta = function(x) {
# make sure some variables are available in metadata
x = merge_list(list(classoption = '', documentclass = 'article', body_class = 'body'), x)
names(x) = gsub('_', '-', names(x))
x
}
# turn '+a-b c' to list(a = TRUE, b = FALSE, c = TRUE)
option2list = function(x) {
if (!is.character(x)) return(as.list(x))
x = unlist(strsplit(x, '\\b(?=[+-])', perl = TRUE))
x = unlist(strsplit(x, '\\s+'))
x = setdiff(x, '')
i = grepl('^-', x)
c(named_bool(sub('^[-]', '', x[i]), FALSE), named_bool(sub('^[+]', '', x[!i])))
}
pkg_file = function(...) {
system.file(..., package = 'litedown', mustWork = TRUE)
}
jsdelivr = function(file, dir = 'npm/@xiee/utils/') {
ifelse(is_https(file), file, sprintf('https://cdn.jsdelivr.net/%s%s', dir, file))
}
# get the latest version of jsdelivr assets
jsd_version = local({
vers = list() # cache versions in current session
# find version from local cache
p_cache = function() {
d = if (getRversion() >= '4.0') tools::R_user_dir('litedown', 'cache') else {
file.path(dirname(tempdir()), 'R', 'cache', 'litedown')
}
file.path(d, 'jsd_versions.rds')
}
# update cache to a specific version
u_cache = function(info, pkg, version, file) {
if (!grepl('^@', version)) version = paste0('@', version)
info[[pkg]] = list(version = version, time = Sys.time())
saveRDS(info, file)
version
}
# cache expires after one week by default
v_cache = function(pkg, force, delta = getOption('litedown.jsdelivr.cache', 604800)) {
if (!isTRUE(force) && file.exists(f <- p_cache())) {
info = readRDS(f)
if (is.character(force)) {
u_cache(info, pkg, force, f)
} else {
info = info[[pkg]]
if (!is.null(t <- info$time) && Sys.time() - t <= delta) info$version
}
}
}
# query version from jsdelivr api
v_api = function(pkg) {
x = tryCatch(
read_utf8(paste0('https://data.jsdelivr.com/v1/packages/', pkg, '/resolved?specifier=latest')),
error = function(e) v_cache(pkg, FALSE, Inf) # fall back to local cache
)
v = grep_sub('.*"version":\\s*"([0-9.]+)".*', '@\\1', x)
if (length(v)) {
if (dir_create(dirname(f <- p_cache()))) {
info = if (file.exists(f)) readRDS(f) else list()
u_cache(info, pkg, v[1], f)
}
v[1]
}
}
# force can be TRUE/FALSE/version number
function(pkg, force = FALSE) {
if (isFALSE(force) && is.character(v <- vers[[pkg]])) return(v)
v = v_cache(pkg, force) %||% v_api(pkg)
(vers[[pkg]] <<- if (length(v)) v[1] else '')
}
})
jsd_versions = function(pkgs) uapply(pkgs, jsd_version)
# resolve the implicit latest version to current latest version
jsd_resolve = function(x) {
if (!getOption('litedown.jsd_resolve', TRUE)) return(x)
rs = paste0(c(
'((?<=https://cdn.jsdelivr.net/combine/)|(?<=,))',
'(?<=https://cdn.jsdelivr.net/)(?!combine/)'
), '([^/]+/(@[^/]+/)?[^/@]+)((?=/)|(?=@latest$)|$)')
for (r in rs) x = match_replace(x, r, function(z) {
paste0(z, jsd_versions(z))
})
x = sub('@latest$', '', x)
x
}
# if both @foo and foo are present, remove foo
resolve_dups = function(x) {
x = unique(x)
for (i in grep('^@', x, value = TRUE)) {
x = x[x != sub('^@', '', i)]
}
x
}
# add filename extensions to paths without extensions: the path should contain
# no slashes (@xiee/utils assets) or at least 2 slashes when the npm package
# name doesn't start with @ (otherwise the path should contain >= 3 slashes),
# e.g. don't add ext for npm/simple-datatables
add_ext = function(x, ext) {
n = vapply(strsplit(x, ''), function(z) sum(z == '/'), 0)
i = file_ext(x) == '' & (n == 0 | n > grepl('^[^/]+/@', x) + 2)
x[i] = paste0(x[i], ext)
x
}
# resolve CSS/JS shorthand filenames to actual paths (e.g., 'default' to 'default.css')
resolve_files = function(x, ext = 'css') {
x = resolve_dups(x)
if (length(x) == 0) return(x)
min_ext = paste0('.min.', ext)
# @foo -> jsdelivr.net/npm/@xiee/utils/ext/foo.min.ext
i0 = grepl('^@', x)
x[i0] = sub('^@', '', x[i0])
# @foo@version -> @npm/@xiee/utils@version/foo
i = i0 & !grepl('[/,]', x)
x[i] = sub('^(.+?)@(.+)$', sprintf('npm/@xiee/utils@\\2/%s/\\1', ext), x[i])
# if no extension is specified, use .min.ext
x[i0] = add_ext(x[i0], min_ext)
i = i0 & !grepl('[/,]', x)
x[i] = jsdelivr(paste0(ext, '/', x[i]))
# @foo/bar -> jsdelivr.net/foo/bar
i = i0 & !grepl(',', x)
x[i] = jsdelivr(x[i], '')
# @foo/bar,baz -> jsdelivr.net/combine/foo/bar,foo/baz
i = i0 & grepl(',', x)
if (any(i)) x[i] = sapply(strsplit(x[i], ',\\s*'), function(z) {
d = dirname(z[1])
if (d == '.') d = paste0('npm/@xiee/utils/', ext)
for (j in seq_along(z)) {
if (grepl('/', z[j])) {
d = dirname(z[j])
} else {
z[j] = paste(d, z[j], sep = '/')
}
}
z = add_ext(z, min_ext)
paste0('combine/', paste(z, collapse = ','))
})
x[i] = jsdelivr(x[i], '')
x[i0] = jsd_resolve(x[i0])
i = dirname(x) == '.' & file_ext(x) == '' & !file_exists(x)
x[i] = map_assets(x[i], ext)
x = if (ext %in% c('css', 'js')) gen_tags(x, ext) else read_all(x)
I(x)
}
map_assets = function(x, ext) {
if (length(x) == 0) return(x)
x[x == 'slides'] = 'snap' # alias slides.css -> snap.css
# built-in resources in this package
b1 = c(if (ext != 'js') 'default', 'snap')
i1 = x %in% b1
x[i1] = file.path(pkg_file('resources'), sprintf('%s.%s', x[i1], ext))
# in case users forgot to type @ for jsdelivr assets
b2 = sub('@', '', assets[, ext])
i2 = x %in% b2
x[i2] = jsdelivr(sprintf('%s/%s.min.%s', ext, x[i2], ext))
x[i2] = jsd_resolve(x[i2])
if (any(i3 <- !(i1 | i2))) stop(
"Invalid '", ext, "' option: ", paste0("'", x[i3], "'", collapse = ', '),
" (possible values are: ", paste0("'", unique(c(b1, na_omit(b2))), "'", collapse = ', '), ")"
)
x
}
# generate tags for css/js depending on whether they need to be embedded or offline
gen_tag = function(
x, ext = file_ext(x), embed_https = FALSE, embed_local = FALSE,
offline = FALSE, attr = ' defer'
) {
if (ext == 'css') {
t1 = '<link rel="stylesheet" href="%s">'
t2 = c('<style type="text/css">', '</style>')
} else if (ext == 'js') {
t1 = paste0('<script src="%s"', attr, '></script>')
t2 = c('<script>', '</script>')
} else stop("The file extension '", ext, "' is not supported.")
is_web = is_https(x)
is_rel = !is_web && is_rel_path(x)
if (is_web && embed_https && xfun::url_filename(x) == 'MathJax.js') {
warning('MathJax.js cannot be embedded. Please use MathJax v3 instead.')
embed_https = FALSE
}
# linking for 1) local rel paths that don't need to be embedded, or 2) web
# resources that don't need to be accessed offline
link1 = is_rel && !embed_local
link2 = is_web && !embed_https
if (link1 || link2) {
if (link2) x = download_url(
x, offline, handler = function(code) resolve_url(x, code, ext, FALSE)
)
sprintf(t1, x)
} else {
# embedding for other cases
one_string(c(t2[1], resolve_external(x, is_web, ext), t2[2]))
}
}
# check if path starts with https://, but also tolerate http://
is_https = function(x) grepl('^https?://', x)
# a vectorized version
gen_tags = function(...) mapply(gen_tag, ..., USE.NAMES = FALSE)
# read CSS/JS and embed external fonts/background images, etc.
resolve_external = function(x, web = TRUE, ext = '') {
# download and cache web resources
if (web) download_cache$get(x, 'text', handler = function(code) {
# remove jsdelivr comments
if (grepl('^https://cdn[.]jsdelivr[.]net/', x)) {
code = gsub(
'^/[*][*]\n( [*][^\n]*\n)+ [*]/\n|\n/[*/]# sourceMappingURL=.+[.]map( [*]/)?$',
'', one_string(code)
)
code = resolve_url(x, code, ext)
}
code
}) else {
resolve_url(x, read_utf8(x), ext)
}
}
# find url("path") in JS/CSS and base64 encode or download the resources
resolve_url = function(url, code, ext, encode = TRUE) {
d = dirname(url)
# embed fonts in mathjax's js
if (grepl('^https://cdn[.]jsdelivr[.]net/npm/mathjax.+[.]js$', url)) {
r = '.*?fontURL:[^"]+\\("([^"]+)".*' # output/chtml/fonts/woff-v2
p = grep_sub(r, '\\1', code)
if (length(p) == 1) code = match_replace(
code, '(?<=src:\'url\\(")(%%URL%%/[^"]+)(?="\\))', function(u) {
f = sub('%%URL%%/', '', u, fixed = TRUE)
u2 = paste(d, p, f, sep = '/')
if (encode) {
uapply(u2, download_cache$get, 'base64')
} else {
.mapply(function(u, f) download_url(u, p, f), u2, f)
u
}
}
) else warning(
'Unable to determine the font path in MathJax. Please report an issue to ',
'https://github.com/yihui/litedown/issues and mention the URL ', url, '.'
)
}
# find `attr: url(resource)` and embed url resources in CSS
if (ext == 'css') {
r = '(: ?url\\(["\']?)([^"\')]+)(["\']?\\))'
code = match_replace(code, r, function(z) {
z1 = gsub(r, '\\1', z)
z2 = gsub(r, '\\2', z)
z3 = gsub(r, '\\3', z)
i = is_https(z2)
u = ifelse(i, z2, sprintf('%s/%s', d, z2))
z2 = unlist(if (encode) {
lapply(u, function(x) {
if (is_https(x)) download_cache$get(x, 'base64') else base64_uri(x)
})
} else {
.mapply(function(u, i, f) download_url(u, '.', if (!i) f), u, i, z2)
})
paste0(z1, z2, z3)
})
}
code
}
# download a file to a local dir if the local file doesn't exist
download_url = function(url, dir = '.', file = NULL, handler = NULL) {
if (!is.character(dir) || !is_https(url) || grepl('^http://127.0.0.1', url))
return(url)
f = file %||% gsub('^https?://|[?#].*$', '', url)
p = URLdecode(f)
# see if a previous version of the jsd asset exists
if (dir.exists(dir) && startsWith(p, 'cdn.jsdelivr.net/')) in_dir(dir, {
p2 = sub('@[0-9.]+/', '@*/', p)
if (n <- length(p2 <- Sys.glob(p2))) p = p2[n]
})
if (dir != '.') p = file.path(dir, p)
if (!file_exists(p)) {
xfun::download_file(url, p)
if (is.function(handler)) xfun::process_file(p, function(x) {
x # force eval before changing wd
in_dir(dirname(p), handler(x))
})
}
URLencode(p)
}
# compact HTML code
clean_html = function(x) {
x = gsub('\n+(\n<[a-z1-6]+[^>]*>|\n</(body|div|head|html)>)', '\\1', x)
# can also merge <style>/<script> tags (<style type="text/css">).+?</style>\\s*\\1
x
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.