The legacy-html generator creates legacy HTML documentation pages for Node.js API documentation with included assets and styles for retro-compatibility.
Attributes
output:
stringThe directory where HTML files and assets will be written.
templatePath?:
stringPath to the HTML template file.
Default:
'template.html'.additionalPathsToCopy?:
string[]Array of paths to copy to the output
directory. Default:
['assets'].ref?:
stringGit reference/branch for linking to source files.
Default:
'main'.pageURL?:
stringURL template for documentation page links.
Default:
'{baseURL}/latest-{version}/api{path}.html'.editURL?:
stringURL template for "edit this page" links.
Default:
'${GITHUB_EDIT_URL}/doc/api{path}.md'.index:
ArrayArray of
{ api, section } objects defining the
documentation structure.minify?:
booleanWhether to minify the output HTML. Inherited from
global. Default: true.