oldBuildHTML: oldBuildHTML

In pik-piam/goxygen: In-Code Documentation for 'GAMS'

oldBuildHTML

Description

Converts a folder with markdown files and a corresponding literature library (if available) to HTML files and creates cross-links between them.

Usage

oldBuildHTML(
  folder = "html",
  mdfolder = "markdown",
  literature = "literature.bib",
  citation = "../CITATION.cff",
  supplementary = NULL,
  addHTML = NULL
)

Arguments

folder	location the HTML files should be written to
mdfolder	path to the markdown folder to be used as source
literature	path to a bibliography, if available (will be ignored if file does not exist)
citation	Citation information in citation file format (optional)
supplementary	a vector of files and/or folders required for the conversion (e.g. an images subdirectory with figures to be shown in the documents)
addHTML	character vector with HTML code which should be added to the body of each HTML file.

Details

Pandoc (https://pandoc.org/) together with pandoc-citeproc need to be installed on the system.

Author(s)

Jan Philipp Dietrich

See Also

goxygen, buildTEX

pik-piam/goxygen documentation built on Feb. 1, 2024, 5:35 p.m.