{"$schema":"https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json","id":"generators-legacy-html-all","path":"/generators/legacy-html-all","type":"module","module":"generators-legacy-html-all","title":"Legacy single-page HTML","introducedIn":null,"sourceLink":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The `legacy-html-all` generator writes `all.html`, the page of Node.js's\nlegacy HTML format that holds all the others, one after another. Every legacy\npage links to it as \"View on single page\". It exists for Node.js; the\n[website](https://doc-kit.nodejs.org/generators/html) generator writes an\n`all.html` of its own.","summary":"The `legacy-html-all` generator writes `all.html`, the page of Node.js's legacy HTML format that holds all the others, one after another. Every legacy page links to it as \"View on single page\". It exists for Node.js; the website generator writes an `all.html` of its own.","examples":[],"children":[{"kind":"section","id":"usage","name":"Usage","title":"Usage","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"From the root of a Node.js checkout, with `repository` and `baseURL` set as\nfor [Legacy HTML](https://doc-kit.nodejs.org/generators/legacy-html#usage):\n\n```bash\nnpx @doc-kit/cli generate -t legacy-html-all -i \"doc/api/*.md\" -o out \\\n  --index doc/api/index.md --changelog CHANGELOG.md --version 24.1.0\n```\n\nThis writes `out/all.html`. `legacy-html` runs first without being listed, and\nwrites its pages and `assets/` to the same directory, which `all.html` needs:\nit loads its stylesheet from `assets/` and links to the pages in its sidebar.","summary":"From the root of a Node.js checkout, with `repository` and `baseURL` set as for Legacy HTML:","examples":[{"language":"bash","displayName":null,"code":"npx @doc-kit/cli generate -t legacy-html-all -i \"doc/api/*.md\" -o out \\\n  --index doc/api/index.md --changelog CHANGELOG.md --version 24.1.0"}],"children":[]},{"kind":"section","id":"configuring","name":"Configuring","title":"Configuring","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"* `templatePath` {string} The HTML template the page is written into, with the\n  placeholders of\n  [the `legacy-html` template](https://doc-kit.nodejs.org/generators/legacy-html#the-template).\n  Setting `legacy-html.templatePath` doesn't change it, so set both to use\n  your own. **Default:** the bundled `template.html`.\n\nIt also reads the\n[global options](https://doc-kit.nodejs.org/configuration#global-options). The\npage's version and its \"Other versions\" picker come from `version` and\n`changelog`, as on the other pages, and the picker's links from\n`legacy-html.pageURL`.","summary":"It also reads the global options. The page's version and its \"Other versions\" picker come from `version` and `changelog`, as on the other pages, and the picker's links from `legacy-html.pageURL`.","examples":[],"children":[]},{"kind":"section","id":"what-the-page-holds","name":"What the page holds","title":"What the page holds","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The template, filled as for the other pages, with:\n\n* `all` as the file name and `All` as the title.\n* Every page's table of contents and content, one after another, except\n  those of the top-level `index.md`.\n* A sidebar linking to each of those pages.\n* No \"Edit on GitHub\" link and no \"Index\" picker.","summary":"The template, filled as for the other pages, with:","examples":[],"children":[]}]}