Format individual table of contents line

Source: R/format_toc_entry.R

The function is used for its side-effect of printing a table of contents entry.

format_toc_entry(entry, padding = "2em", html_file = "")

Arguments

entry

a character string to be converted to a Table of Contents entry.

padding

a character string to be added to the front of the entry string typically for indentation purposes.

html_file

URL for the page containing the node. Defaults to "" indicating current page.

Examples

format_toc_entry(c("Header 1", "Header 2"))
#> <span  style="padding-left: 2em; text-indent: -2em;">[Header 1](#header-1) [Header 2](#header-2) <BR>
#> </span>
format_toc_entry("Header 1", "---->", "mypage.html")
#> <span  style="padding-left: ---->; text-indent: ----->;">[Header 1](mypage.html#header-1) <BR>
#> </span>