{"$schema":"https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json","id":"generators-llms-txt-full","path":"/generators/llms-txt-full","type":"module","module":"generators-llms-txt-full","title":"llms-full.txt","introducedIn":null,"sourceLink":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The `llms-txt-full` generator writes the Markdown of every page into one\n`llms-full.txt` file, each page after its URL, so a language model can read\nall of your docs in a single request. Pair it with\n[`llms.txt`](https://doc-kit.nodejs.org/generators/llms-txt), which only links\nto each page.","summary":"The `llms-txt-full` generator writes the Markdown of every page into one `llms-full.txt` file, each page after its URL, so a language model can read all of your docs in a single request. Pair it with `llms.txt`, which only links to each page.","examples":[],"children":[{"kind":"section","id":"usage","name":"Usage","title":"Usage","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"Each page's URL starts with `baseURL`, so set it to where your docs are\npublished. There is no flag for it, so set it in your configuration file.\n\n```bash\nnpx @doc-kit/cli generate -t llms-txt -t llms-txt-full -i \"docs/**/*.md\" -o out\n```\n\nThis writes `out/llms.txt` and `out/llms-full.txt`.","summary":"Each page's URL starts with `baseURL`, so set it to where your docs are published. There is no flag for it, so set it in your configuration file.","examples":[{"language":"bash","displayName":null,"code":"npx @doc-kit/cli generate -t llms-txt -t llms-txt-full -i \"docs/**/*.md\" -o out"}],"children":[]},{"kind":"section","id":"configuring","name":"Configuring","title":"Configuring","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"* `pageURL` {string} URL template written before each page. `{path}` is the\n  page's extensionless path, starting with a slash (`/fs`); see\n  [templates](https://doc-kit.nodejs.org/configuration#generator-options).\n  It's set apart from `llms-txt.pageURL`, which has the same default.\n  **Default:** `'{baseURL}{path}.md'`.\n* `markdown` {Object} Its own remark plugins. See\n  [Markdown plugins](https://doc-kit.nodejs.org/configuration#markdown-plugins).\n\nIt also reads the\n[global options](https://doc-kit.nodejs.org/configuration#global-options).\n\nThe default URLs point at each page's Markdown file, which none of the\nbuilt-in generators write: copy your sources into the output, as in\n[Serving pages as Markdown](https://doc-kit.nodejs.org/generators/llms-txt#serving-pages-as-markdown),\nor set `pageURL` to `'{baseURL}{path}.html'` to point at the website's pages.","summary":"It also reads the global options.","examples":[],"children":[]},{"kind":"section","id":"what-the-file-holds","name":"What the file holds","title":"What the file holds","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"Every page read from your sources, one after another. Each starts with a `url`\nblock between `---` lines, built from `pageURL`, followed by the page's\nMarkdown. For this page and a `path.md` next to it:\n\n```md displayName=\"docs/fs.md\"\n# File system\n\n<!-- YAML\nadded: v1.0.0\n-->\n\nThe `fs` module reads and writes files. Paths can be built with\n[`path.join()`][join].\n\n### `fs.readFile(path)`\n\n- `path` {string|URL} The file to read.\n- Returns: {Promise<Buffer>}\n\n[join]: ./path.md#pathjoinparts\n```\n\n`llms-full.txt` holds:\n\n```text displayName=\"out/llms-full.txt\"\n---\nurl: https://docs.example.com/fs.md\n---\n# File system\n\nThe `fs` module reads and writes files. Paths can be built with\n[`path.join()`](./path.html#pathjoinparts).\n\n### `fs.readFile(path)`\n\n* `path` {string | URL} The file to read.\n* Returns: {Promise<Buffer>}\n\n---\nurl: https://docs.example.com/path.md\n---\n# Path\n\n### `path.join(...parts)`\n\nJoins path segments.\n```\n\nThe Markdown is rebuilt from the\n[API entries](https://doc-kit.nodejs.org/generators/metadata), not copied from\nyour files, so it differs from the sources in a few ways:\n\n* Links to `.md` files point to the `.html` pages.\n* Reference-style links become inline links, and their definitions are\n  dropped.\n* Formatting is normalized: bullet lists and emphasis use `*`, strong text\n  uses `**`, and a page without a heading starts with an empty `#`.\n* `<!-- YAML -->` comments are left out.\n* Type annotations are rewritten with spaces around `|` (`{string|URL}`\n  becomes `{string | URL}`). MDX pages keep their JSX.","summary":"Every page read from your sources, one after another. Each starts with a `url` block between `---` lines, built from `pageURL`, followed by the page's Markdown. For this page and a `path.md` next to it:","examples":[{"language":"md","displayName":"docs/fs.md","code":"# File system\n\n<!-- YAML\nadded: v1.0.0\n-->\n\nThe `fs` module reads and writes files. Paths can be built with\n[`path.join()`][join].\n\n### `fs.readFile(path)`\n\n- `path` {string|URL} The file to read.\n- Returns: {Promise<Buffer>}\n\n[join]: ./path.md#pathjoinparts"},{"language":"text","displayName":"out/llms-full.txt","code":"---\nurl: https://docs.example.com/fs.md\n---\n# File system\n\nThe `fs` module reads and writes files. Paths can be built with\n[`path.join()`](./path.html#pathjoinparts).\n\n### `fs.readFile(path)`\n\n* `path` {string | URL} The file to read.\n* Returns: {Promise<Buffer>}\n\n---\nurl: https://docs.example.com/path.md\n---\n# Path\n\n### `path.join(...parts)`\n\nJoins path segments."}],"children":[]}]}