{"_id":"@4hse/astro-llms-txt","_rev":"5-d47bf08cebd90896ce52c6e57875015f","name":"@4hse/astro-llms-txt","dist-tags":{"latest":"1.0.5"},"versions":{"1.0.0":{"name":"@4hse/astro-llms-txt","version":"1.0.0","keywords":["llms.txt","withastro","astro"],"author":{"name":"4hse"},"license":"MIT","_id":"@4hse/astro-llms-txt@1.0.0","maintainers":[{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"}],"homepage":"https://delucis.github.io/starlight-llms-txt/","bugs":{"url":"https://github.com/delucis/starlight-llms-txt/issues"},"dist":{"shasum":"8b9a6a2f7e133d2027c29d56d33b4ae105685057","tarball":"https://registry.npmjs.org/@4hse/astro-llms-txt/-/astro-llms-txt-1.0.0.tgz","fileCount":4,"integrity":"sha512-2v9Y3N07ZmTKGoUNnNchFn/vFmAn+/DejewkAawBCIihivzi7EaTraPqqsyHuOE7ros8PAU26oOVuYmJ4LW35Q==","signatures":[{"sig":"MEYCIQCp6YVNZgwEMcRthVc2uXEpvKjxvWlBxa5D6Sks32R3qQIhAIAoXu4XJ5kTXe1w8CJHnRRQiiYLXy3yReoQJnCEqd01","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":13109},"type":"module","engines":{"node":"^18.17.1 || ^20.3.0 || >=21.0.0"},"exports":{".":"./index.ts"},"gitHead":"985f8e505994cac7fa3006dfbf6d8f19e50d5dab","_npmUser":{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"},"repository":{"url":"git+https://github.com/delucis/starlight-llms-txt.git","type":"git","directory":"packages/starlight-llms-txt"},"_npmVersion":"10.9.2","description":"Generate llms.txt files to train large language models on your astro project","directories":{},"_nodeVersion":"22.13.1","dependencies":{"jsdom":"^26.1.0","unified":"^11.0.5","micromatch":"^4.0.8","remark-gfm":"^4.0.0","@types/hast":"^3.0.4","@astrojs/mdx":"^4.0.5","@types/jsdom":"^21.1.7","rehype-parse":"^9.0.1","rehype-remark":"^10.0.0","github-slugger":"^2.0.0","hast-util-select":"^6.0.3","remark-stringify":"^11.0.0","@types/micromatch":"^4.0.9","unist-util-remove":"^4.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"astro":"^5.1.6"},"peerDependencies":{"astro":"^5.1.6"},"_npmOperationalInternal":{"tmp":"tmp/astro-llms-txt_1.0.0_1750071953326_0.13689917130623042","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@4hse/astro-llms-txt","version":"1.0.1","keywords":["llms.txt","withastro","astro"],"author":{"name":"4hse"},"license":"MIT","_id":"@4hse/astro-llms-txt@1.0.1","maintainers":[{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"}],"homepage":"https://delucis.github.io/starlight-llms-txt/","bugs":{"url":"https://github.com/delucis/starlight-llms-txt/issues"},"dist":{"shasum":"63554b9064cb0f23c04654731bf00e537d8cc01e","tarball":"https://registry.npmjs.org/@4hse/astro-llms-txt/-/astro-llms-txt-1.0.1.tgz","fileCount":4,"integrity":"sha512-nDHx8XnslhtJ9ky+iR2u5Obt+qZj0xkgmI3eCaC9y7JZmTm2/Pr48uCrl8PWs8EI1osX6FmBe/UkTm9vnKDJsg==","signatures":[{"sig":"MEUCIQCy8AhIj2LJvLiY8xaV68/yowuDZlNLyVsW1gQrS1ZjXgIgeLogLV1XMw/z4CD4y862reU5qg1WJ3VFqHgjjRXTq6k=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":13113},"type":"module","engines":{"node":"^18.17.1 || ^20.3.0 || >=21.0.0"},"exports":{".":"./src/index.ts"},"gitHead":"1e847b08da79ce85be336a6033c613ea529999a6","_npmUser":{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"},"repository":{"url":"git+https://github.com/delucis/starlight-llms-txt.git","type":"git","directory":"packages/starlight-llms-txt"},"_npmVersion":"10.9.2","description":"Generate llms.txt files to train large language models on your astro project","directories":{},"_nodeVersion":"22.13.1","dependencies":{"jsdom":"^26.1.0","unified":"^11.0.5","micromatch":"^4.0.8","remark-gfm":"^4.0.0","@types/hast":"^3.0.4","@astrojs/mdx":"^4.0.5","@types/jsdom":"^21.1.7","rehype-parse":"^9.0.1","rehype-remark":"^10.0.0","github-slugger":"^2.0.0","hast-util-select":"^6.0.3","remark-stringify":"^11.0.0","@types/micromatch":"^4.0.9","unist-util-remove":"^4.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"astro":"^5.1.6"},"peerDependencies":{"astro":"^5.1.6"},"_npmOperationalInternal":{"tmp":"tmp/astro-llms-txt_1.0.1_1750072085192_0.029444794986296374","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@4hse/astro-llms-txt","version":"1.0.2","keywords":["llms.txt","withastro","astro"],"author":{"name":"4hse"},"license":"MIT","_id":"@4hse/astro-llms-txt@1.0.2","maintainers":[{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"}],"homepage":"https://delucis.github.io/starlight-llms-txt/","bugs":{"url":"https://github.com/delucis/starlight-llms-txt/issues"},"dist":{"shasum":"3fea5e3d5a4c6513d39eb74d8b77b7a4e2a060ff","tarball":"https://registry.npmjs.org/@4hse/astro-llms-txt/-/astro-llms-txt-1.0.2.tgz","fileCount":5,"integrity":"sha512-0RsDi2g7i/A9noccFS8WIRiovGAEloIFcl3k84BYA6CLkZuc81Kjq4J0I2aGGVhugGhOg3CgCSNVPvMcgKK5ZA==","signatures":[{"sig":"MEYCIQDBShGZimnjiDvoJgsxkJRKwEo0MYGZ+gVc1I/o4i2cEgIhAIishtww82IQcXtSJytyDdXzOJUZQ3mdUZqRjpLkPt3M","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":17006},"type":"module","engines":{"node":"^18.17.1 || ^20.3.0 || >=21.0.0"},"exports":{".":"./src/index.ts"},"gitHead":"1e847b08da79ce85be336a6033c613ea529999a6","_npmUser":{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"},"repository":{"url":"git+https://github.com/delucis/starlight-llms-txt.git","type":"git","directory":"packages/starlight-llms-txt"},"_npmVersion":"10.9.2","description":"Generate llms.txt files to train large language models on your astro project","directories":{},"_nodeVersion":"22.13.1","dependencies":{"jsdom":"^26.1.0","unified":"^11.0.5","micromatch":"^4.0.8","remark-gfm":"^4.0.0","@types/hast":"^3.0.4","@astrojs/mdx":"^4.0.5","@types/jsdom":"^21.1.7","rehype-parse":"^9.0.1","rehype-remark":"^10.0.0","github-slugger":"^2.0.0","hast-util-select":"^6.0.3","remark-stringify":"^11.0.0","@types/micromatch":"^4.0.9","unist-util-remove":"^4.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"astro":"^5.1.6"},"peerDependencies":{"astro":"^5.1.6"},"_npmOperationalInternal":{"tmp":"tmp/astro-llms-txt_1.0.2_1750074868509_0.8457437778746049","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@4hse/astro-llms-txt","version":"1.0.4","keywords":["llms.txt","withastro","astro"],"author":{"name":"4hse"},"license":"MIT","_id":"@4hse/astro-llms-txt@1.0.4","maintainers":[{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"}],"homepage":"https://www.4hse.com","bugs":{"url":"https://github.com/4hse/astro-llms-txt/issues"},"dist":{"shasum":"68c8e80ac1a1c0a23872cf0c6466889f7012bcaa","tarball":"https://registry.npmjs.org/@4hse/astro-llms-txt/-/astro-llms-txt-1.0.4.tgz","fileCount":5,"integrity":"sha512-ujD9iu95SMxYau42rRRFrPDIgjhThUpm786g835j1pAJ0vmFV0FV3dIDYtaJSxsopUlRChUqfjwPv+YV2amdXw==","signatures":[{"sig":"MEUCIF/oaAJR4zIEnX7lm8ntRnrIdxu07uH+lFAbetN6L7xeAiEAtDddS3bJ+CP/rBltlUnGzAa7h4XHB+NBmnBD5mOR4t4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":16921},"type":"module","engines":{"node":"^18.17.1 || ^20.3.0 || >=21.0.0"},"exports":{".":"./src/index.ts"},"gitHead":"02de23875f12d256ecd22d55568219205dab4c2b","_npmUser":{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"},"repository":{"url":"git+https://github.com/4hse/astro-llms-txt.git","type":"git"},"_npmVersion":"10.9.2","description":"Generate llms.txt files to train large language models on your astro project","directories":{},"_nodeVersion":"22.13.1","dependencies":{"jsdom":"^26.1.0","unified":"^11.0.5","micromatch":"^4.0.8","remark-gfm":"^4.0.0","@types/hast":"^3.0.4","@astrojs/mdx":"^4.0.5","@types/jsdom":"^21.1.7","rehype-parse":"^9.0.1","rehype-remark":"^10.0.0","github-slugger":"^2.0.0","hast-util-select":"^6.0.3","remark-stringify":"^11.0.0","@types/micromatch":"^4.0.9","unist-util-remove":"^4.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"astro":"^5.1.6"},"peerDependencies":{"astro":"^5.1.6"},"_npmOperationalInternal":{"tmp":"tmp/astro-llms-txt_1.0.4_1750074993147_0.6899503747220315","host":"s3://npm-registry-packages-npm-production"}},"1.0.5":{"name":"@4hse/astro-llms-txt","version":"1.0.5","license":"MIT","description":"Generate llms.txt files to train large language models on your astro project","author":{"name":"4hse"},"type":"module","exports":{".":"./src/index.ts"},"dependencies":{"@astrojs/mdx":"^4.0.5","@types/hast":"^3.0.4","@types/jsdom":"^21.1.7","@types/micromatch":"^4.0.9","github-slugger":"^2.0.0","hast-util-select":"^6.0.3","jsdom":"^26.1.0","micromatch":"^4.0.8","rehype-parse":"^9.0.1","rehype-remark":"^10.0.0","remark-gfm":"^4.0.0","remark-stringify":"^11.0.0","unified":"^11.0.5","unist-util-remove":"^4.0.0"},"devDependencies":{"astro":"^5.1.6 || ^6.0.0"},"peerDependencies":{"astro":"^5.1.6 || ^6.0.0"},"engines":{"node":"^18.17.1 || ^20.3.0 || >=21.0.0"},"publishConfig":{"access":"public"},"homepage":"https://www.4hse.com","repository":{"type":"git","url":"git+https://github.com/4hse/astro-llms-txt.git"},"bugs":{"url":"https://github.com/4hse/astro-llms-txt/issues"},"keywords":["llms.txt","withastro","astro"],"_id":"@4hse/astro-llms-txt@1.0.5","gitHead":"e6b25832c8ed49b62b5022eee8bb4d4a7be747f4","_nodeVersion":"22.13.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-f8e9fDagVYwQp+WpzLZyj4lWtoMrbj5GGUnRJSjMkWL/2Ar07rHUClpo9c2XsHAH/Cf45JX1+SuduhXgBbanHw==","shasum":"4733c6783ff478c28c93ead5fd76a3d8249e0c1e","tarball":"https://registry.npmjs.org/@4hse/astro-llms-txt/-/astro-llms-txt-1.0.5.tgz","fileCount":5,"unpackedSize":16941,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD8jPeSJbzIxOSgn7ZsST3wThtwgTKV8Wfp2zF4TqQj8gIgaCz15IFtEz28mqQL+0GRfaFrprRjeeYoW7MwfJBrPo8="}]},"_npmUser":{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"},"directories":{},"maintainers":[{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/astro-llms-txt_1.0.5_1776778762024_0.009575109530553183"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-16T11:05:53.261Z","modified":"2026-04-21T13:39:22.359Z","1.0.0":"2025-06-16T11:05:53.483Z","1.0.1":"2025-06-16T11:08:05.375Z","1.0.2":"2025-06-16T11:54:28.690Z","1.0.4":"2025-06-16T11:56:33.309Z","1.0.5":"2026-04-21T13:39:22.211Z"},"bugs":{"url":"https://github.com/4hse/astro-llms-txt/issues"},"author":{"name":"4hse"},"license":"MIT","homepage":"https://www.4hse.com","keywords":["llms.txt","withastro","astro"],"repository":{"type":"git","url":"git+https://github.com/4hse/astro-llms-txt.git"},"description":"Generate llms.txt files to train large language models on your astro project","maintainers":[{"name":"adriano-4hse","email":"adriano.foschi@4hse.com"}],"readme":"# @4hse/astro-llms-txt\n\nAn Astro integration to generate AI‑friendly documentation files:\n\n- **`/llms.txt`** – primary index with title, description, and structured links  \n- **`/llms-small.txt`** – ultra‑compact version containing only page structure (titles, lists)  \n- **`/llms-full.txt`** – full Markdown documentation in a single file  \n\n---\n\n## Installation\n\n```bash\nnpm install @4hse/astro-llms-txt\n# or\nyarn add @4hse/astro-llms-txt\n```\n\n## Usage\n\n```javascript\nimport { defineConfig } from 'astro/config';\nimport astroLlmsTxt from '@4hse/astro-llms-txt';\n\nexport default defineConfig({\n  site: 'https://www.4hse.com',\n  integrations: [\n    astroLlmsTxt({\n      title: '4HSE',\n      description: '4HSE is cloud‑based HSE software that automates workplace safety processes…',\n      details: 'Additional context or guidelines.',\n      notes: '- This content is auto‑generated from the official source.',\n      optionalLinks: [\n        {\n          label: 'News',\n          url: 'https://www.4hse.com/en/news',\n          description: 'Latest company news',\n        },\n      ],\n      docSet: [\n        {\n          title: 'Complete site',\n          description: 'The full site of 4HSE',\n          url: '/llms-full.txt',\n          include: ['en/', 'en/**'],\n          promote: ['en/'],\n        },\n        {\n          title: 'Small site',\n          description: 'Index of key pages',\n          url: '/llms-small.txt',\n          include: ['en/', 'en/**'],\n          onlyStructure: true,\n          promote: ['en/'],\n        },\n      ],\n      pageSeparator: '\\n\\n---\\n\\n',\n    }),\n  ],\n});\n```\n\n- `onlyStructure`: true makes `llms-small.txt` include only headings and list structure.\n\n- Use `promote`/`demote` with glob patterns for ordering pages.\n\n- Customize `mainSelector` or `ignoreSelectors` when scraping non-standard HTML.\n\n## Difference: small vs. full\n\n- `llms-small.txt`: extremely concise—keeps only hierarchy (titles, lists), ideal for agents with limited token budget.\n\n- `llms-full.txt`: exports entire documentation in a single file with full Markdown—suitable for RAG flows, IDEs, or tools that ingest content once.\n\n## Configuration summary\n\n### llms.txt config\n\n| Property        | Type                             | Description                      |\n| --------------- | -------------------------------- | -------------------------------- |\n| `title`         | `string`                         | Root H1 header                   |\n| `description`   | `string?`                        | Blockquote under title           |\n| `details`       | `string?`                        | Expanded guidance paragraphs     |\n| `notes`         | `string?`                        | Footer note                      |\n| `optionalLinks` | `{ label, url, description }[]?` | Non-essential references         |\n| `docSet`        | `DocSet[]?`                      | Sets of documentation files      |\n| `pageSeparator` | `string?`                        | Custom separator between entries |\n\n### Single DocSet config\n\n| Property          | Type        | Description                             |\n| ----------------- | ----------- | --------------------------------------- |\n| `title`           | `string`    | Section title                           |\n| `description`     | `string`    | Blockquote in each file                 |\n| `url`             | `string`    | Output file URL (e.g. `/llms-full.txt`) |\n| `include`         | `string[]`  | Glob patterns for pages                 |\n| `promote`         | `string[]?` | Globs to push pages higher              |\n| `demote`          | `string[]?` | Globs to push pages lower               |\n| `onlyStructure`   | `boolean?`  | If true, extracts headings + lists only |\n| `mainSelector`    | `string?`   | CSS selector for main HTML root         |\n| `ignoreSelectors` | `string[]?` | CSS selectors to skip in HTMl to MD     |\n","readmeFilename":"README.md"}