{"_id":"@cerbos/antora-llm-generator","_rev":"7-5fc1744ea498a7f1d8a0e7fcdd8aa94c","name":"@cerbos/antora-llm-generator","dist-tags":{"latest":"1.1.2"},"versions":{"1.0.0":{"name":"@cerbos/antora-llm-generator","version":"1.0.0","keywords":["antora","antora-extension","llm","rag"],"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","_id":"@cerbos/antora-llm-generator@1.0.0","maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"dist":{"shasum":"533ed54d52861ac419b126df0596e9fe1a173589","tarball":"https://registry.npmjs.org/@cerbos/antora-llm-generator/-/antora-llm-generator-1.0.0.tgz","fileCount":3,"integrity":"sha512-s/XP+dL8dfcYwowJNK1F9W5rPD52LL639DdsLZb+yJTWnpeHubN0IsHyrjKpnByIPmGeyWmUD2Q72wtw15TjDQ==","signatures":[{"sig":"MEQCIBxTacPzIAtImJNt/ktEbveWAie1BcjOzNGpOX2qB+/LAiAJqLREJ7cpQts5y8K/tQRY1zJQJB1duf/G8SD40GPR7w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":2972},"main":"llm-generator.js","gitHead":"6a5d26041373cdda054a778dfe3c1fc950854b01","private":false,"_npmUser":{"name":"alexolivier","actor":{"name":"alexolivier","type":"user","email":"alex@alexolivier.me"},"email":"alex@alexolivier.me"},"_npmVersion":"10.9.2","description":"An Antora extension to generate llm.txt files for LLM consumption.","directories":{},"_nodeVersion":"22.16.0","dependencies":{"minimatch":"7","node-html-markdown":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-llm-generator_1.0.0_1750324298183_0.16245826577396016","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@cerbos/antora-llm-generator","version":"1.0.1","keywords":["antora","antora-extension","llm","rag"],"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","_id":"@cerbos/antora-llm-generator@1.0.1","maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"dist":{"shasum":"17d148a187ac792126a727f41161dc64a8406811","tarball":"https://registry.npmjs.org/@cerbos/antora-llm-generator/-/antora-llm-generator-1.0.1.tgz","fileCount":3,"integrity":"sha512-kjvN6cN2X4MRH1ejPVn/0yuC7wHD8pWjTO5yVvBiCK+HoJsVAvU/rFBm2OjhLxSiLDdFDt5D0R1Zc+m8NoPcgw==","signatures":[{"sig":"MEUCIDQJYJDC/bcoC5K79md0Oer1Qg+iHcTDGpWwm/J8m/TbAiEAyefrn6+8K3mq/rL7a3KqhdIpAT3HrbCajGXQgG/tDy0=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":4652},"main":"llm-generator.js","gitHead":"35453ee299e5315dcfd39da0cf55023c6c73da9f","private":false,"_npmUser":{"name":"alexolivier","actor":{"name":"alexolivier","type":"user","email":"alex@alexolivier.me"},"email":"alex@alexolivier.me"},"_npmVersion":"10.9.2","description":"An Antora extension to generate llm.txt files for LLM consumption.","directories":{},"_nodeVersion":"22.16.0","dependencies":{"minimatch":"7","node-html-markdown":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-llm-generator_1.0.1_1750342256350_0.6428716479697072","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@cerbos/antora-llm-generator","version":"1.0.2","keywords":["antora","antora-extension","llm","rag"],"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","_id":"@cerbos/antora-llm-generator@1.0.2","maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"dist":{"shasum":"d96f5787646a2169308390d1c78bc0fd43860ce4","tarball":"https://registry.npmjs.org/@cerbos/antora-llm-generator/-/antora-llm-generator-1.0.2.tgz","fileCount":3,"integrity":"sha512-xyNuQx2UeIXIdAW3OaWpkcNCTMxg+MLZ7qEXfaCYpoj072FvsXyafEqJNnzKvKiXHiokWiEzG1hsqYZiJ4G18Q==","signatures":[{"sig":"MEUCIAbRTZC/Vo1nBG06a3JzC40gUwtV0sBSzkh6+/NIeMkIAiEA643avZpbCScDyaQZl4wT9ptSmjvVnrWmoSNELtw2YjY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":4930},"main":"llm-generator.js","gitHead":"32e7f46c8420cb85631c79c412cb84421bc9b620","private":false,"_npmUser":{"name":"alexolivier","actor":{"name":"alexolivier","type":"user","email":"alex@alexolivier.me"},"email":"alex@alexolivier.me"},"_npmVersion":"10.9.2","description":"An Antora extension to generate llm.txt files for LLM consumption.","directories":{},"_nodeVersion":"22.16.0","dependencies":{"minimatch":"7","node-html-markdown":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-llm-generator_1.0.2_1750691134980_0.47560444417311265","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@cerbos/antora-llm-generator","version":"1.0.3","keywords":["antora","antora-extension","llm","rag"],"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","_id":"@cerbos/antora-llm-generator@1.0.3","maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"dist":{"shasum":"3bc5ecdd84fdea0ac755c559ac60e381cfcd421a","tarball":"https://registry.npmjs.org/@cerbos/antora-llm-generator/-/antora-llm-generator-1.0.3.tgz","fileCount":3,"integrity":"sha512-KlhFET5K6dLlifUplbu92J2HBgfItqM5TZ6pcP/M9NUlZfRz+40ed2afYdZS8gb5f+BOE/nLZNTQM1Hkn2oFmQ==","signatures":[{"sig":"MEYCIQCDB2jjScdV06oL/ka8Esy6YzY90bk7R01uYs7xqlutWQIhAIeABdircPfnzgcj0lbOHBGrRjx2XaEJLHOZist+oEs0","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":4930},"main":"llm-generator.js","gitHead":"a234e250f553f0975687bf0afd5f2372edcea5fa","private":false,"_npmUser":{"name":"alexolivier","actor":{"name":"alexolivier","type":"user","email":"alex@alexolivier.me"},"email":"alex@alexolivier.me"},"_npmVersion":"10.9.2","description":"An Antora extension to generate llm.txt files for LLM consumption.","directories":{},"_nodeVersion":"22.16.0","dependencies":{"minimatch":"7","node-html-markdown":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-llm-generator_1.0.3_1750691173237_0.7665766524211657","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@cerbos/antora-llm-generator","version":"1.1.0","keywords":["antora","antora-extension","llm","rag"],"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","_id":"@cerbos/antora-llm-generator@1.1.0","maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"dist":{"shasum":"53da06d4102df7e74900e8edb3cc3ca5f7197ef7","tarball":"https://registry.npmjs.org/@cerbos/antora-llm-generator/-/antora-llm-generator-1.1.0.tgz","fileCount":3,"integrity":"sha512-Ntkz59CozQ/VjBpFEY13miYnbcRYc6SBHMQr6fECq9O3ffqlEC6V1bJBhdnJ18A0b5mG1G9SAy2D69CQDWPG/Q==","signatures":[{"sig":"MEUCIDKOKK8+UdPJKGdAs3oZoiYc46VcbWZ+CeF+hFEsvxQ6AiEAhTFm/qJjSGDcI0O5fqkVMXaGPTos1QfPZQE0w/L5ZCU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":5970},"main":"llm-generator.js","gitHead":"2942ad3c4702fddc212e548acf96d109a398c950","private":false,"_npmUser":{"name":"alexolivier","email":"alex@alexolivier.me"},"_npmVersion":"11.6.2","description":"An Antora extension to generate llm.txt files for LLM consumption.","directories":{},"_nodeVersion":"24.11.1","dependencies":{"minimatch":"7","node-html-markdown":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-llm-generator_1.1.0_1782144340656_0.43712393253312953","host":"s3://npm-registry-packages-npm-production"}},"1.1.1":{"name":"@cerbos/antora-llm-generator","version":"1.1.1","keywords":["antora","antora-extension","llm","rag"],"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","_id":"@cerbos/antora-llm-generator@1.1.1","maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"dist":{"shasum":"0baca50e7a90066175affab7e8d41b90ab17cfeb","tarball":"https://registry.npmjs.org/@cerbos/antora-llm-generator/-/antora-llm-generator-1.1.1.tgz","fileCount":4,"integrity":"sha512-rvX3ExhvZB8XTZGdbdkbdrB2pRMP08DbxmVNqqkhkKX1LsXSNygdmNNyJlob5W2mzgR5JPQ8mxEktq/B8D5Stg==","signatures":[{"sig":"MEUCIHIXfKqlyTCN6rR9F8HT48cDxXgJmnhof8eBWzJSGp5gAiEAwvNPqqoqn9/q67+kZz3XG5V0VPtyTGBAJlXAJMwPugE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":6935},"main":"llm-generator.js","gitHead":"9ffdba7a2887c9f56938eb2befc67e110c506999","private":false,"_npmUser":{"name":"alexolivier","email":"alex@alexolivier.me"},"_npmVersion":"11.6.2","description":"An Antora extension to generate llm.txt files for LLM consumption.","directories":{},"_nodeVersion":"24.11.1","dependencies":{"minimatch":"10","node-html-markdown":"^1.3.0"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/antora-llm-generator_1.1.1_1782144435906_0.4280820018491791","host":"s3://npm-registry-packages-npm-production"}},"1.1.2":{"name":"@cerbos/antora-llm-generator","private":false,"version":"1.1.2","description":"An Antora extension to generate llm.txt files for LLM consumption.","main":"llm-generator.js","keywords":["antora","antora-extension","llm","rag"],"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","engines":{"node":">=16"},"dependencies":{"minimatch":"^9.0.5","node-html-markdown":"^1.3.0"},"gitHead":"9ffdba7a2887c9f56938eb2befc67e110c506999","_id":"@cerbos/antora-llm-generator@1.1.2","_nodeVersion":"24.11.1","_npmVersion":"11.6.2","dist":{"integrity":"sha512-V63JEnF6nvVBrygKfr/8rh/oLr1vh9Muesz0VdXHUaGQyUabjqS54whRiw8GbBxjPu1vpjTt9tspNpfuhho1fw==","shasum":"3ee7e618bcb6400a7a130e72dc24c2978e10cd2e","tarball":"https://registry.npmjs.org/@cerbos/antora-llm-generator/-/antora-llm-generator-1.1.2.tgz","fileCount":4,"unpackedSize":7107,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEJms6/DhD28kcOasNDJ8OSQw53L3LeKqIGUHUtpdSnfAiBG+lVnvOKOJooFn+aaYjDD7zqk5CvjHen8NdfhwE2TFg=="}]},"_npmUser":{"name":"alexolivier","email":"alex@alexolivier.me"},"directories":{},"maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/antora-llm-generator_1.1.2_1782144641741_0.07375742099727112"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-19T09:11:38.064Z","modified":"2026-06-22T16:10:42.033Z","1.0.0":"2025-06-19T09:11:38.352Z","1.0.1":"2025-06-19T14:10:56.553Z","1.0.2":"2025-06-23T15:05:35.134Z","1.0.3":"2025-06-23T15:06:13.394Z","1.1.0":"2026-06-22T16:05:40.803Z","1.1.1":"2026-06-22T16:07:16.070Z","1.1.2":"2026-06-22T16:10:41.886Z"},"author":{"name":"ZenAuth Ltd."},"license":"Apache-2.0","keywords":["antora","antora-extension","llm","rag"],"description":"An Antora extension to generate llm.txt files for LLM consumption.","maintainers":[{"name":"alexolivier","email":"alex@alexolivier.me"},{"name":"ahaines","email":"andrew@haines.org.nz"}],"readme":"# `@cerbos/antora-llm-generator`\n\n`@cerbos/antora-llm-generator` is an [Antora](https://antora.org) extension that makes your documentation site agent-friendly. After each build it creates:\n\n- **`llms.txt`** — an index of every page, following the [llmstxt.org](https://llmstxt.org/) spec.\n- **`llms-full.txt`** — the full text of every page concatenated into one Markdown document.\n- **A `.md` file for every page** — each rendered page is also written as Markdown alongside its HTML (e.g. `/docs/foo.html` → `/docs/foo.md`), so agents and crawlers can fetch a clean, LLM-friendly version of any individual page.\n\n---\n\n## Installation\n\n```bash\nyarn global add @cerbos/antora-llm-generator\n# or\nnpm install --global @cerbos/antora-llm-generator\n```\n\n---\n\n## Playbook configuration\n\nAdd the extension to your `antora-playbook.yaml`:\n\n```yaml\nantora:\n  extensions:\n    - require: \"@cerbos/antora-llm-generator\"\n      skippaths:\n        - \"someGlob/**/path\"\n      pagemarkdown: true\n```\n\n- `skippaths` accepts one or more glob patterns. Any file that matches a pattern is omitted from **both** `llm.txt` and `llm-full.txt`, and no per-page `.md` file is generated for it.\n- `pagemarkdown` (default `true`) toggles generation of the per-page `.md` files. Set it to `false` to emit only the aggregate `llms.txt` / `llms-full.txt` files.\n\n---\n\n## Page-level exclusions\n\nYou can exclude individual pages without touching the playbook by setting AsciiDoc page attributes:\n\n```adoc\n:page-llms-ignore: true     # omit from llms.txt\n:page-llms-full-ignore: true # omit from llms-full.txt\n:page-llms-description: Brief description of this page # add description to page link in llms.txt\n```\n\nApply any or all attributes at the top of the source file.\n\n### Page descriptions\n\nThe `:page-llms-description:` attribute allows you to add optional descriptions to page links in `llms.txt`, following the [llmstxt.org specification](https://llmstxt.org/). \n\n**Without description:**\n```markdown\n- [Getting Started](https://example.com/getting-started)\n```\n\n**With description:**\n```markdown  \n- [Getting Started](https://example.com/getting-started): Quick start guide for new users\n```\n\n---\n\n## Building the site\n\nRun your Antora build as usual:\n\n```bash\nantora antora-playbook.yaml\n```\n\nOn completion, `/llms.txt` and `/llms-full.txt` appear in the build output directory, and a `.md` companion is written next to every page's HTML output. Distribute or host them wherever LLMs need access.\n\n---\n\n### At a glance\n\n- **Purpose**: supply LLM-ready summaries of your documentation site.\n- **Zero friction**: install, update the playbook, rebuild.\n- **Granular control**: exclude by path globs or per-page attributes.\n\nFor more details, visit [https://llmstxt.org/](https://llmstxt.org/).\n","readmeFilename":"README.md"}