format_toc_entry: Format individual table of contents line

View source: R/format_toc_entry.R

format_toc_entryR Documentation

Format individual table of contents line

Description

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

Usage

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"))
format_toc_entry("Header 1", "---->", "mypage.html")

johnaclouse/curios documentation built on June 14, 2022, 6:45 a.m.