{"_id":"typedoc-plugin-llms-txt","_rev":"3-f07fec29b27c46b402cdcbcb4edbbbb7","name":"typedoc-plugin-llms-txt","dist-tags":{"latest":"0.1.2"},"versions":{"0.1.0":{"name":"typedoc-plugin-llms-txt","version":"0.1.0","keywords":["typedoc","typedoc-plugin","llms","llms.txt","ai","documentation"],"author":{"url":"https://boneskull.com/","name":"Christopher Hiller","email":"boneskull@boneskull.com"},"license":"BlueOak-1.0.0","_id":"typedoc-plugin-llms-txt@0.1.0","maintainers":[{"name":"boneskull","email":"boneskull@boneskull.com"}],"homepage":"https://github.com/boneskull/typedoc-plugin-llms-txt#readme","bugs":{"url":"https://github.com/boneskull/typedoc-plugin-llms-txt/issues"},"dist":{"shasum":"9a919d272980ca77162f492c2db32ff2fdb66600","tarball":"https://registry.npmjs.org/typedoc-plugin-llms-txt/-/typedoc-plugin-llms-txt-0.1.0.tgz","fileCount":24,"integrity":"sha512-F/g30W7l3BfI9DSsy3ROuaAf8EmDLzmccnDC10O1GV6r7hSBCi5JvQzH8L0maNUHyon8EsNC/OBBnJyNmbqgLw==","signatures":[{"sig":"MEQCIEjyVMpsXt9nSL9/aODpetj7S9fFgt3E670Af1WbfLRtAiB0WCLYk/E7M+y+y4+vbxYTDQYrZ6l+j2Jum06K5cA9zA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":90688},"knip":{"tags":["-knipignore"],"ignore":["**/*.d.ts",".worktrees/**/*"],"ignoreDependencies":["markdownlint-cli2-formatter-pretty"]},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.cts","module":"./dist/index.js","engines":{"node":">=22.0.0"},"exports":{".":{"types":"./dist/index.d.cts","import":"./dist/index.js","require":"./dist/index.cjs"},"./package.json":"./package.json"},"gitHead":"d10c794a370090367ec5bbf91cd9a46ba66ed7eb","scripts":{"fix":"run-s -sl fix:*","lint":"run-p -sl --aggregate-output lint:*","test":"run-s test:runtime","build":"tsc -p tsconfig.build.json","fix:pkg":"npm pkg fix","prepare":"husky; run-s -s build","lint:knip":"knip","commitlint":"commitlint","fix:eslint":"eslint --fix .","lint:types":"tsc --noEmit","test:watch":"node --import tsx --test --test-reporter=spec --watch \"test/**/*.test.ts\"","lint-staged":"lint-staged","lint:eslint":"eslint .","fix:markdown":"markdownlint-cli2 --fix \"**/*.md\"","fix:prettier":"prettier --write . && markdownlint-cli2 --fix \"**/*.md\"","test:runtime":"node --import tsx --test --test-reporter=spec \"test/**/*.test.ts\"","lint:markdown":"markdownlint-cli2 \"**/*.md\"","lint:prettier":"prettier --check .","lint:spelling":"cspell . \"./.*/**\""},"_npmUser":{"name":"boneskull","email":"boneskull@boneskull.com"},"prettier":{"tsdoc":true,"plugins":["prettier-plugin-jsdoc","prettier-plugin-pkg"],"singleQuote":true,"jsdocPreferCodeFences":true,"jsdocCommentLineStrategy":"keep"},"repository":{"url":"git+https://github.com/boneskull/typedoc-plugin-llms-txt.git","type":"git"},"_npmVersion":"11.6.2","description":"TypeDoc plugin to generate llms.txt files for LLM consumption","directories":{},"lint-staged":{"*.md":["markdownlint-cli2 --fix","prettier --write","cspell lint --no-must-find-files"],"*.{ts,js,yml,json5}":["eslint --fix","prettier --write","cspell lint --no-must-find-files"],"**/!(package-lock).json":["eslint --fix","prettier --write","cspell lint --no-must-find-files"]},"_nodeVersion":"24.12.0","_hasShrinkwrap":false,"devDependencies":{"tsx":"4.21.0","knip":"5.78.0","husky":"9.1.7","bupkis":"0.14.0","cspell":"9.4.0","eslint":"9.39.2","globals":"16.5.0","typedoc":"0.28.16","prettier":"3.7.4","@eslint/js":"9.39.2","typescript":"5.9.3","@types/node":"24.10.4","lint-staged":"16.2.7","npm-run-all2":"8.0.4","@commitlint/cli":"20.2.0","markdownlint-cli2":"0.20.0","typescript-eslint":"8.51.0","eslint-plugin-jsonc":"2.21.0","prettier-plugin-pkg":"0.21.2","prettier-plugin-jsdoc":"1.8.0","@stylistic/eslint-plugin":"5.6.1","eslint-plugin-perfectionist":"5.2.0","@commitlint/config-conventional":"20.2.0","markdownlint-cli2-formatter-pretty":"0.0.9"},"peerDependencies":{"typedoc":">=0.28.16"},"_npmOperationalInternal":{"tmp":"tmp/typedoc-plugin-llms-txt_0.1.0_1768603906231_0.34095386695959373","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"typedoc-plugin-llms-txt","version":"0.1.1","keywords":["typedoc","typedoc-plugin","llms","llms.txt","ai","documentation"],"author":{"url":"https://boneskull.com/","name":"Christopher Hiller","email":"boneskull@boneskull.com"},"license":"BlueOak-1.0.0","_id":"typedoc-plugin-llms-txt@0.1.1","maintainers":[{"name":"boneskull","email":"boneskull@boneskull.com"}],"homepage":"https://github.com/boneskull/typedoc-plugin-llms-txt#readme","bugs":{"url":"https://github.com/boneskull/typedoc-plugin-llms-txt/issues"},"dist":{"shasum":"9ab46bcb3434d49f314495192733a278ea20a364","tarball":"https://registry.npmjs.org/typedoc-plugin-llms-txt/-/typedoc-plugin-llms-txt-0.1.1.tgz","fileCount":24,"integrity":"sha512-RX98ypsjgo8izhGbT3lRpk611do0CktiP4Y9ceKYmZXLpNmhjzQzXIqopbsSQDb5KFAvSq8ThNwHHsVM2DcEFA==","signatures":[{"sig":"MEUCIQCeDNjdrRawFQ3oZjiOYhycVsz40y3p+BLC7ZIP5f7L7wIgOuJNcXxxir4WygK5LWYTTSm31BIYXZzm8p5H6l4beB4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/typedoc-plugin-llms-txt@0.1.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":91070},"knip":{"tags":["-knipignore"],"ignore":["**/*.d.ts",".worktrees/**/*"],"ignoreDependencies":["markdownlint-cli2-formatter-pretty"]},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.cts","module":"./dist/index.js","engines":{"node":">=22.0.0"},"exports":{".":{"types":"./dist/index.d.cts","import":"./dist/index.js","require":"./dist/index.cjs"},"./package.json":"./package.json"},"gitHead":"e8052bcbd449050234ab03bce2efa95bf7e0ca37","scripts":{"fix":"run-s -sl fix:*","lint":"run-p -sl --aggregate-output lint:*","test":"run-s test:runtime","build":"tsc -p tsconfig.build.json","fix:pkg":"npm pkg fix","prepare":"husky; run-s -s build","lint:knip":"knip","commitlint":"commitlint","fix:eslint":"eslint --fix .","lint:types":"tsc --noEmit","test:watch":"node --import tsx --test --test-reporter=spec --watch \"test/**/*.test.ts\"","lint-staged":"lint-staged","lint:eslint":"eslint .","fix:markdown":"markdownlint-cli2 --fix \"**/*.md\"","fix:prettier":"prettier --write . && markdownlint-cli2 --fix \"**/*.md\"","test:runtime":"node --import tsx --test --test-reporter=spec \"test/**/*.test.ts\"","lint:markdown":"markdownlint-cli2 \"**/*.md\"","lint:prettier":"prettier --check .","lint:spelling":"cspell . \"./.*/**\""},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:de08824b-55dd-4617-9968-ead4089b0a42"}},"prettier":{"tsdoc":true,"plugins":["prettier-plugin-jsdoc","prettier-plugin-pkg"],"singleQuote":true,"jsdocPreferCodeFences":true,"jsdocCommentLineStrategy":"keep"},"repository":{"url":"git+https://github.com/boneskull/typedoc-plugin-llms-txt.git","type":"git"},"_npmVersion":"11.6.2","description":"TypeDoc plugin to generate llms.txt files for LLM consumption","directories":{},"lint-staged":{"*.md":["markdownlint-cli2 --fix","prettier --write","cspell lint --no-must-find-files"],"*.{ts,js,yml,json5}":["eslint --fix","prettier --write","cspell lint --no-must-find-files"],"**/!(package-lock).json":["eslint --fix","prettier --write","cspell lint --no-must-find-files"]},"_nodeVersion":"24.12.0","_hasShrinkwrap":false,"devDependencies":{"tsx":"4.21.0","knip":"5.78.0","husky":"9.1.7","bupkis":"0.14.0","cspell":"9.4.0","eslint":"9.39.2","globals":"16.5.0","typedoc":"0.28.16","prettier":"3.7.4","@eslint/js":"9.39.2","typescript":"5.9.3","@types/node":"24.10.4","lint-staged":"16.2.7","npm-run-all2":"8.0.4","@commitlint/cli":"20.2.0","markdownlint-cli2":"0.20.0","typescript-eslint":"8.51.0","eslint-plugin-jsonc":"2.21.0","prettier-plugin-pkg":"0.21.2","prettier-plugin-jsdoc":"1.8.0","@stylistic/eslint-plugin":"5.6.1","eslint-plugin-perfectionist":"5.2.0","@commitlint/config-conventional":"20.2.0","markdownlint-cli2-formatter-pretty":"0.0.9"},"peerDependencies":{"typedoc":"^0.28.0"},"_npmOperationalInternal":{"tmp":"tmp/typedoc-plugin-llms-txt_0.1.1_1768703278319_0.9017336376972238","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"typedoc-plugin-llms-txt","version":"0.1.2","type":"module","description":"TypeDoc plugin to generate llms.txt files for LLM consumption","repository":{"type":"git","url":"git+https://github.com/boneskull/typedoc-plugin-llms-txt.git"},"author":{"name":"Christopher Hiller","email":"boneskull@boneskull.com","url":"https://boneskull.com/"},"license":"BlueOak-1.0.0","engines":{"node":">=22.0.0"},"main":"./dist/index.cjs","types":"./dist/index.d.cts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.cts","import":"./dist/index.js","require":"./dist/index.cjs"},"./package.json":"./package.json"},"keywords":["typedoc","typedoc-plugin","llms","llms.txt","ai","documentation"],"scripts":{"build":"tsc -p tsconfig.build.json","commitlint":"commitlint","fix":"run-s -sl fix:*","fix:eslint":"eslint --fix .","fix:markdown":"markdownlint-cli2 --fix \"**/*.md\"","fix:pkg":"npm pkg fix","fix:prettier":"prettier --write . && markdownlint-cli2 --fix \"**/*.md\"","lint":"run-p -sl --aggregate-output lint:*","lint-staged":"lint-staged","lint:eslint":"eslint .","lint:knip":"knip","lint:markdown":"markdownlint-cli2 \"**/*.md\"","lint:prettier":"prettier --check .","lint:spelling":"cspell . \"./.*/**\"","lint:types":"tsc --noEmit","prepare":"husky; run-s -s build","test":"run-s test:runtime","test:runtime":"node --import tsx --test --test-reporter=spec \"test/**/*.test.ts\"","test:watch":"node --import tsx --test --test-reporter=spec --watch \"test/**/*.test.ts\""},"peerDependencies":{"typedoc":"^0.28.0"},"devDependencies":{"@commitlint/cli":"20.2.0","@commitlint/config-conventional":"20.2.0","@eslint/js":"9.39.2","@stylistic/eslint-plugin":"5.6.1","@types/node":"24.10.4","bupkis":"0.14.0","cspell":"9.4.0","eslint":"9.39.2","eslint-plugin-jsonc":"2.21.0","eslint-plugin-perfectionist":"5.2.0","globals":"16.5.0","husky":"9.1.7","knip":"5.78.0","lint-staged":"16.2.7","markdownlint-cli2":"0.20.0","markdownlint-cli2-formatter-pretty":"0.0.9","npm-run-all2":"8.0.4","prettier":"3.7.4","prettier-plugin-jsdoc":"1.8.0","prettier-plugin-pkg":"0.21.2","tsx":"4.21.0","typedoc":"0.28.16","typescript":"5.9.3","typescript-eslint":"8.51.0"},"knip":{"ignoreDependencies":["markdownlint-cli2-formatter-pretty"],"ignore":["**/*.d.ts",".worktrees/**/*","example/**/*"],"tags":["-knipignore"]},"lint-staged":{"*.{ts,js,yml,json5}":["eslint --fix","prettier --write","cspell lint --no-must-find-files"],"**/!(package-lock).json":["eslint --fix","prettier --write","cspell lint --no-must-find-files"],"*.md":["markdownlint-cli2 --fix","prettier --write","cspell lint --no-must-find-files"]},"prettier":{"jsdocCommentLineStrategy":"keep","jsdocPreferCodeFences":true,"plugins":["prettier-plugin-jsdoc","prettier-plugin-pkg"],"singleQuote":true,"tsdoc":true},"gitHead":"796de4a866a8ec05ca7bde0a6e53e1359332c28f","_id":"typedoc-plugin-llms-txt@0.1.2","bugs":{"url":"https://github.com/boneskull/typedoc-plugin-llms-txt/issues"},"homepage":"https://github.com/boneskull/typedoc-plugin-llms-txt#readme","_nodeVersion":"24.12.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-9q7x5ZdwkSZKJK23cvirtfQw87970n2p/hSv3T0YlOlgIY6isRHdUOM+QPErANFPXZv0X+ezS6QZp10dejOExQ==","shasum":"12d5950d31878cddf66509a70bc6683d1d46d49d","tarball":"https://registry.npmjs.org/typedoc-plugin-llms-txt/-/typedoc-plugin-llms-txt-0.1.2.tgz","fileCount":24,"unpackedSize":97643,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/typedoc-plugin-llms-txt@0.1.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHY/wrOv9IMRfr3A4ygOWPNb0gLII5gjP/U5uO7xsaz0AiAb+GrXMlNlIFwVFrphmYDTmA5iC7N3Sj2u9NTnyx0R5A=="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:de08824b-55dd-4617-9968-ead4089b0a42"}},"directories":{},"maintainers":[{"name":"boneskull","email":"boneskull@boneskull.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/typedoc-plugin-llms-txt_0.1.2_1769922139298_0.7052712985380258"},"_hasShrinkwrap":false}},"time":{"created":"2026-01-16T22:51:46.230Z","modified":"2026-02-01T05:02:19.723Z","0.1.0":"2026-01-16T22:51:46.392Z","0.1.1":"2026-01-18T02:27:58.478Z","0.1.2":"2026-02-01T05:02:19.434Z"},"bugs":{"url":"https://github.com/boneskull/typedoc-plugin-llms-txt/issues"},"author":{"name":"Christopher Hiller","email":"boneskull@boneskull.com","url":"https://boneskull.com/"},"license":"BlueOak-1.0.0","homepage":"https://github.com/boneskull/typedoc-plugin-llms-txt#readme","keywords":["typedoc","typedoc-plugin","llms","llms.txt","ai","documentation"],"repository":{"type":"git","url":"git+https://github.com/boneskull/typedoc-plugin-llms-txt.git"},"description":"TypeDoc plugin to generate llms.txt files for LLM consumption","maintainers":[{"name":"boneskull","email":"boneskull@boneskull.com"}],"readme":"# typedoc-plugin-llms-txt\n\nA TypeDoc plugin that generates `llms.txt` files for LLM consumption.\n\n## What is llms.txt?\n\n[llms.txt](https://llmstxt.org/) is a convention for providing LLM-friendly documentation summaries. This plugin automatically generates an `llms.txt` file from your TypeDoc documentation.\n\n## Installation\n\n```bash\nnpm install typedoc-plugin-llms-txt typedoc -D\n```\n\n> `typedoc` v0.28.0 or later is a required peer dependency.\n\n## Usage\n\nAdd the plugin to your TypeDoc configuration:\n\n```js\n// typedoc.config.js\nexport default {\n  plugin: ['typedoc-plugin-llms-txt'],\n  // ... other options\n};\n```\n\nThat's it! The plugin will generate an `llms.txt` file in your output directory with reasonable defaults.\n\n## Zero-Config Defaults\n\nThe plugin works out of the box with sensible defaults:\n\n- **Project name**: From TypeDoc's `name` option\n- **Description**: From your `package.json` description\n- **Sections**: Auto-discovered from `projectDocuments` frontmatter categories\n- **API links**: Auto-generated from TypeDoc entry points\n\n## Configuration\n\nCustomize the output with these TypeDoc options:\n\n### `llmsTxt`\n\nEnable or disable llms.txt generation. Default: `true`\n\n### `llmsTxtFilename`\n\nOutput filename. Default: `\"llms.txt\"`\n\n### `llmsTxtHeader`\n\nCustomize the header section:\n\n```js\n{\n  llmsTxtHeader: {\n    name: 'My Project',           // defaults to TypeDoc name\n    description: 'A cool library', // defaults to package.json description\n    features: [                    // defaults to empty\n      'Feature one',\n      'Feature two',\n    ],\n  },\n}\n```\n\n### `llmsTxtSections`\n\nControl how document categories are displayed and ordered:\n\n```js\n{\n  llmsTxtSections: {\n    Guides: { displayName: 'Documentation', order: 1 },\n    Reference: { displayName: 'Reference', order: 2 },\n    About: { displayName: 'Optional', order: 3 },\n  },\n}\n```\n\nCategories not listed use their original name and appear alphabetically after configured sections.\n\n### `llmsTxtDeclarations`\n\nAdd links to specific API symbols using TypeDoc declaration references:\n\n```js\n{\n  llmsTxtDeclarations: [\n    { ref: 'myproject!', label: 'API Reference', description: 'Full API docs' },\n    { ref: 'myproject!myFunction', label: 'myFunction()' },\n  ],\n}\n```\n\n### `llmsTxtQuickReference`\n\nAdd a code examples section:\n\n```js\n{\n  llmsTxtQuickReference: `\n// Basic usage\nimport { foo } from 'myproject';\nfoo();\n`,\n}\n```\n\n### `llmsTxtTemplate`\n\nUse a custom template file for full layout control:\n\n```js\n{\n  llmsTxtTemplate: './llms-template.md',\n}\n```\n\nTemplate slots:\n\n- `{{header}}` - Name, description, and features\n- `{{sections}}` - All document sections\n- `{{section:CategoryName}}` - Specific category\n- `{{declarations}}` - API links\n- `{{quickReference}}` - Code examples\n\n## License\n\n[BlueOak-1.0.0](https://blueoakcouncil.org/license/1.0.0)\n","readmeFilename":"README.md"}