{"_id":"@awesome-myst/myst-astro-collections","_rev":"6-4a228c49d46b9098a59407ff10181841","name":"@awesome-myst/myst-astro-collections","dist-tags":{"latest":"2.1.0"},"versions":{"1.0.0":{"name":"@awesome-myst/myst-astro-collections","version":"1.0.0","keywords":["astro","myst","content-collections","documentation"],"author":{"name":"Fideus Labs LLC"},"license":"MIT","_id":"@awesome-myst/myst-astro-collections@1.0.0","maintainers":[{"name":"thewtex","email":"matt@mmmccormick.com"}],"dist":{"shasum":"28ea2eb7c8a10e49e304fce618fbe208c4729996","tarball":"https://registry.npmjs.org/@awesome-myst/myst-astro-collections/-/myst-astro-collections-1.0.0.tgz","fileCount":19,"integrity":"sha512-4WIf6E4mHKJB49nipfp3poXgsDTOseVVd8rLySp6mNAPWUzKPz5hT9YIRwFDcNn+1lEYOGbwJUJtBpwtV6rdTQ==","signatures":[{"sig":"MEQCIDE1uoTpzalPTEFgXupvmPE7u8mpyzTEqjOx9fDA/ESwAiALADU/gmaLPwRANhQJ3HY6u9hJ6SUiMUa7BRGcSj0tWw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":77103},"type":"module","_from":"file:awesome-myst-myst-astro-collections-1.0.0.tgz","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./loaders":{"types":"./dist/loaders.d.ts","import":"./dist/loaders.js"},"./collections":{"types":"./dist/collections.d.ts","import":"./dist/collections.js"}},"scripts":{"dev":"tsc --watch","test":"node tests/test-yaml-loader.mjs","build":"tsc","clean":"rm -rf dist"},"_npmUser":{"name":"thewtex","email":"matt@mmmccormick.com"},"_resolved":"/tmp/98d8138d7300d32f5a624626540c6ca5/awesome-myst-myst-astro-collections-1.0.0.tgz","_integrity":"sha512-4WIf6E4mHKJB49nipfp3poXgsDTOseVVd8rLySp6mNAPWUzKPz5hT9YIRwFDcNn+1lEYOGbwJUJtBpwtV6rdTQ==","_npmVersion":"10.5.2","description":"Astro content collections for MyST projects","directories":{},"_nodeVersion":"22.13.0","dependencies":{"yaml":"^2.8.1","astro":"^5.12.8","p-queue":"^8.1.0","@types/node":"^24.2.0","@awesome-myst/myst-zod":"^0.6.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/myst-astro-collections_1.0.0_1756577962086_0.8787314725856485","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@awesome-myst/myst-astro-collections","version":"1.1.0","keywords":["astro","myst","content-collections","documentation"],"author":{"name":"Fideus Labs LLC"},"license":"MIT","_id":"@awesome-myst/myst-astro-collections@1.1.0","maintainers":[{"name":"thewtex","email":"matt@mmmccormick.com"}],"dist":{"shasum":"b962eb40aa66a4974e75fddbff861db3deef0341","tarball":"https://registry.npmjs.org/@awesome-myst/myst-astro-collections/-/myst-astro-collections-1.1.0.tgz","fileCount":19,"integrity":"sha512-X5PDfkW6PInEfC5ZiiH6C+1OEcAHF7Sbervr5s4o8CEhXc5iR6iKew43WosPNypyYxck6pYMBVBDtgibaGZrEg==","signatures":[{"sig":"MEYCIQDj69hHO7Hlg7VqlroDM9+GDltgywCr2EoRP91YLb9sjQIhAJ6bF/8/Oz9HdLQ5OQHGpntxcflrt3piUu/c47rLoMun","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":78211},"type":"module","_from":"file:awesome-myst-myst-astro-collections-1.1.0.tgz","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./loaders":{"types":"./dist/loaders.d.ts","import":"./dist/loaders.js"},"./collections":{"types":"./dist/collections.d.ts","import":"./dist/collections.js"}},"scripts":{"dev":"tsc --watch","test":"node tests/test-yaml-loader.mjs","build":"tsc","clean":"rm -rf dist"},"_npmUser":{"name":"thewtex","email":"matt@mmmccormick.com"},"_resolved":"/tmp/87605b46f199f20ad748482fd96610c2/awesome-myst-myst-astro-collections-1.1.0.tgz","_integrity":"sha512-X5PDfkW6PInEfC5ZiiH6C+1OEcAHF7Sbervr5s4o8CEhXc5iR6iKew43WosPNypyYxck6pYMBVBDtgibaGZrEg==","_npmVersion":"10.5.2","description":"Astro content collections for MyST projects","directories":{},"_nodeVersion":"22.13.0","dependencies":{"yaml":"^2.8.1","astro":"^5.12.8","p-queue":"^8.1.0","@types/node":"^24.2.0","@awesome-myst/myst-zod":"^0.6.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/myst-astro-collections_1.1.0_1756656538250_0.6641134138772353","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"@awesome-myst/myst-astro-collections","version":"2.0.0","keywords":["astro","myst","content-collections","documentation"],"author":{"name":"Fideus Labs LLC"},"license":"MIT","_id":"@awesome-myst/myst-astro-collections@2.0.0","maintainers":[{"name":"thewtex","email":"matt@mmmccormick.com"}],"dist":{"shasum":"c7a50d6eac6b0b2cb5f7fe9284128046509c9f3c","tarball":"https://registry.npmjs.org/@awesome-myst/myst-astro-collections/-/myst-astro-collections-2.0.0.tgz","fileCount":19,"integrity":"sha512-DGHtREhrG0SQnX4vSh/2TvJh+jSGDvtWj6BIOv80D9lcoITxS8VxWJYOBIhh7MQqLPGTYibdnpG0LpIL1v+C5w==","signatures":[{"sig":"MEUCIEuyrgar7MoAc4FY8Hh4rp3h8VLTfT5yDyOQX5aFWsF2AiEAiKCojp2rreUq686QyKtKVxVd7mmlTeUJfsijSo1SRfY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":77973},"type":"module","_from":"file:awesome-myst-myst-astro-collections-2.0.0.tgz","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./loaders":{"types":"./dist/loaders.d.ts","import":"./dist/loaders.js"},"./collections":{"types":"./dist/collections.d.ts","import":"./dist/collections.js"}},"scripts":{"dev":"tsc --watch","test":"node tests/test-yaml-loader.mjs","build":"tsc","clean":"rm -rf dist"},"_npmUser":{"name":"thewtex","email":"matt@mmmccormick.com"},"_resolved":"/tmp/261b642fe2462f955266b105e3bc2950/awesome-myst-myst-astro-collections-2.0.0.tgz","_integrity":"sha512-DGHtREhrG0SQnX4vSh/2TvJh+jSGDvtWj6BIOv80D9lcoITxS8VxWJYOBIhh7MQqLPGTYibdnpG0LpIL1v+C5w==","_npmVersion":"10.5.2","description":"Astro content collections for MyST projects","directories":{},"_nodeVersion":"22.13.0","dependencies":{"yaml":"^2.8.1","astro":"^5.12.8","p-queue":"^8.1.0","@types/node":"^24.2.0","@awesome-myst/myst-zod":"^0.6.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/myst-astro-collections_2.0.0_1756674349465_0.8130148249051199","host":"s3://npm-registry-packages-npm-production"}},"2.0.1":{"name":"@awesome-myst/myst-astro-collections","version":"2.0.1","keywords":["astro","myst","content-collections","documentation"],"author":{"name":"Fideus Labs LLC"},"license":"MIT","_id":"@awesome-myst/myst-astro-collections@2.0.1","maintainers":[{"name":"thewtex","email":"matt@mmmccormick.com"}],"dist":{"shasum":"3c057f4834e62c39eaa0c038f8cfa1e793573059","tarball":"https://registry.npmjs.org/@awesome-myst/myst-astro-collections/-/myst-astro-collections-2.0.1.tgz","fileCount":19,"integrity":"sha512-4RyZkb/AeKPMYGuHPaWSx6f4qTs1B7oZyZ2+DIY/T7b0NSfRIwGKf9oSfrMYLIU9XPuC0rn2YQdCVKYe4/13tw==","signatures":[{"sig":"MEQCIC7py1GDepfCC8vPQ1eTzHxl1V8uizQZi2Krvl3jDVFiAiB5rrcQtkQ9ETK/9O8bcLeUhwQ6uvkwukutODjTr4Ir6A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":78835},"type":"module","_from":"file:awesome-myst-myst-astro-collections-2.0.1.tgz","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./loaders":{"types":"./dist/loaders.d.ts","import":"./dist/loaders.js"},"./collections":{"types":"./dist/collections.d.ts","import":"./dist/collections.js"}},"scripts":{"dev":"tsc --watch","test":"node tests/test-yaml-loader.mjs","build":"tsc","clean":"rm -rf dist"},"_npmUser":{"name":"thewtex","email":"matt@mmmccormick.com"},"_resolved":"/tmp/c4fa5063c7a17d8a3e67370acdf6b8ba/awesome-myst-myst-astro-collections-2.0.1.tgz","_integrity":"sha512-4RyZkb/AeKPMYGuHPaWSx6f4qTs1B7oZyZ2+DIY/T7b0NSfRIwGKf9oSfrMYLIU9XPuC0rn2YQdCVKYe4/13tw==","_npmVersion":"10.5.2","description":"Astro content collections for MyST projects","directories":{},"_nodeVersion":"22.13.0","dependencies":{"yaml":"^2.8.1","astro":"^5.12.8","p-queue":"^8.1.0","@types/node":"^24.2.0","@awesome-myst/myst-zod":"^0.6.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/myst-astro-collections_2.0.1_1757273771951_0.5901420254763241","host":"s3://npm-registry-packages-npm-production"}},"2.0.2":{"name":"@awesome-myst/myst-astro-collections","version":"2.0.2","keywords":["astro","myst","content-collections","documentation"],"author":{"name":"Fideus Labs LLC"},"license":"MIT","_id":"@awesome-myst/myst-astro-collections@2.0.2","maintainers":[{"name":"thewtex","email":"matt@mmmccormick.com"}],"dist":{"shasum":"75b55829a28885778f717ea3f9cda89a3109b989","tarball":"https://registry.npmjs.org/@awesome-myst/myst-astro-collections/-/myst-astro-collections-2.0.2.tgz","fileCount":19,"integrity":"sha512-so7hN3efSPbKRq2g7UBTcm6BbzrJVVC1ME0L8I5w5VnjujOTpBlmzBZzS+nuLyyPKorZMkzp2r2BOmMLCjqjgQ==","signatures":[{"sig":"MEYCIQDWTvYA6laRdoiFRzRCfb3Ca0jBvAkit22Vo5Ga/zAuTQIhAPi39ajPqAF/05tBY68TyzQ9F5p2HkSV/kVB1YXiL4LT","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":78646},"type":"module","_from":"file:awesome-myst-myst-astro-collections-2.0.2.tgz","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./loaders":{"types":"./dist/loaders.d.ts","import":"./dist/loaders.js"},"./collections":{"types":"./dist/collections.d.ts","import":"./dist/collections.js"}},"scripts":{"dev":"tsc --watch","test":"node tests/test-yaml-loader.mjs","build":"tsc","clean":"rm -rf dist"},"_npmUser":{"name":"thewtex","email":"matt@mmmccormick.com"},"_resolved":"/tmp/2a6ccf4d2fe68f14040f1f2be4d95a86/awesome-myst-myst-astro-collections-2.0.2.tgz","_integrity":"sha512-so7hN3efSPbKRq2g7UBTcm6BbzrJVVC1ME0L8I5w5VnjujOTpBlmzBZzS+nuLyyPKorZMkzp2r2BOmMLCjqjgQ==","_npmVersion":"10.5.2","description":"Astro content collections for MyST projects","directories":{},"_nodeVersion":"22.13.0","dependencies":{"yaml":"^2.8.1","astro":"^5.12.8","p-queue":"^8.1.0","@types/node":"^24.2.0","@awesome-myst/myst-zod":"^0.6.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/myst-astro-collections_2.0.2_1757384442634_0.8776762893335845","host":"s3://npm-registry-packages-npm-production"}},"2.1.0":{"name":"@awesome-myst/myst-astro-collections","version":"2.1.0","description":"Astro content collections for MyST projects","type":"module","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./collections":{"types":"./dist/collections.d.ts","import":"./dist/collections.js"},"./loaders":{"types":"./dist/loaders.d.ts","import":"./dist/loaders.js"}},"keywords":["astro","myst","content-collections","documentation"],"author":{"name":"Fideus Labs LLC"},"license":"MIT","dependencies":{"@awesome-myst/myst-zod":"^0.6.0","@types/node":"^24.2.0","astro":"^5.12.8","p-queue":"^8.1.0","yaml":"^2.8.1"},"devDependencies":{"typescript":"^5.8.3"},"scripts":{"build":"tsc","dev":"tsc --watch","clean":"rm -rf dist","test":"node tests/test-yaml-loader.mjs"},"_id":"@awesome-myst/myst-astro-collections@2.1.0","_integrity":"sha512-3pt+5vuFXz4e9qC8zkl74wQa+NsUZG8nq208DcVqJf8HjYoiAQDnEwf+Z0XkfKpIWaciitpXRsGbKWa3pO4bwg==","_resolved":"/tmp/5bea70245cf90bd3db2e8d709927bbad/awesome-myst-myst-astro-collections-2.1.0.tgz","_from":"file:awesome-myst-myst-astro-collections-2.1.0.tgz","_nodeVersion":"24.11.1","_npmVersion":"11.6.2","dist":{"integrity":"sha512-3pt+5vuFXz4e9qC8zkl74wQa+NsUZG8nq208DcVqJf8HjYoiAQDnEwf+Z0XkfKpIWaciitpXRsGbKWa3pO4bwg==","shasum":"df8cb04c484d0ac5f76d9e0c6c9157e6c7c0f7f9","tarball":"https://registry.npmjs.org/@awesome-myst/myst-astro-collections/-/myst-astro-collections-2.1.0.tgz","fileCount":19,"unpackedSize":81755,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIAsfer5CUs4GsIBwEMF8YqkHEMA7Q5RiA3pI0L8NatoRAiEA1aAJSGKEvhF9xFYau63a6HzyMBOUX901RjD9Y7kosSo="}]},"_npmUser":{"name":"thewtex","email":"matt@mmmccormick.com"},"directories":{},"maintainers":[{"name":"thewtex","email":"matt@mmmccormick.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/myst-astro-collections_2.1.0_1768920842824_0.9167159303318491"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-30T18:19:22.000Z","modified":"2026-01-20T14:54:03.432Z","1.0.0":"2025-08-30T18:19:22.291Z","1.1.0":"2025-08-31T16:08:58.467Z","2.0.0":"2025-08-31T21:05:49.646Z","2.0.1":"2025-09-07T19:36:12.138Z","2.0.2":"2025-09-09T02:20:42.831Z","2.1.0":"2026-01-20T14:54:02.995Z"},"author":{"name":"Fideus Labs LLC"},"license":"MIT","keywords":["astro","myst","content-collections","documentation"],"description":"Astro content collections for MyST projects","maintainers":[{"name":"thewtex","email":"matt@mmmccormick.com"}],"readme":"# @awesome-myst/myst-astro-collections\n\nAstro content collections for MyST projects. This package provides pre-configured collections and loaders for integrating MyST content with Astro's content collection system.\n\n## Features\n\n- **MyST XRef Collection**: Cross-reference data from MyST content server\n- **Pages Collection**: Individual page references extracted from XRef data\n- **Project Frontmatter Collection**: Project configuration from myst.yml\n- **Configurable**: Customizable server URLs, timeouts, and project settings\n- **TypeScript**: Full TypeScript support with proper types from `@awesome-myst/myst-zod`\n\n## Installation\n\n```bash\nnpm install @awesome-myst/myst-astro-collections\n# or\npnpm add @awesome-myst/myst-astro-collections\n```\n\n## Quick Start\n\nIn your `src/content.config.ts`:\n\n```typescript\nimport { mystCollections } from \"@awesome-myst/myst-astro-collections\";\n\nexport const collections = mystCollections;\n```\n\n## Custom Configuration\n\n```typescript\nimport { createMystCollections } from \"@awesome-myst/myst-astro-collections\";\n\nexport const collections = createMystCollections({\n  server: {\n    baseUrl: \"http://localhost:3100\",\n    timeout: 10000,\n  },\n  project: {\n    staticConfig: {\n      version: 1,\n      project: {\n        title: \"My Documentation\",\n        description: \"My awesome docs\",\n      },\n    },\n  },\n});\n```\n\n## Individual Collections\n\nYou can also use collections individually:\n\n```typescript\nimport {\n  createMystXrefCollection,\n  createPagesCollection,\n  createProjectFrontmatterCollection\n} from \"@awesome-myst/myst-astro-collections\";\n\nexport const collections = {\n  mystXref: createMystXrefCollection({\n  baseUrl: \"http://localhost:3100\",\n  generateSearchIndex: true // set to false to disable public/fuse.json\n  }),\n  pages: createPagesCollection(),\n  // Only include the collections you need\n};\n```\n\n## Usage in Pages\n\n```typescript\nimport { getCollection, getEntry } from 'astro:content';\n\n// Get all pages\nconst pages = await getCollection('pages');\n\n// Get project config\nconst project = (await getCollection('projectFrontmatter'))[0];\n\n// Get cross-reference data\nconst xref = await getEntry('mystXref', 'myst-xref');\n```\n\n## API Reference\n\n### Collections\n\n- `mystXref`: Cross-reference data from MyST content server\n- `pages`: Page references filtered from XRef data\n- `projectFrontmatter`: Project configuration data\n\n### Configuration Types\n\n- `MystServerConfig`: Server configuration\n  - `baseUrl` (string): Base URL of the MyST content server (default: `http://localhost:3100`).\n  - `timeout` (number): Request timeout in ms (default: `5000`).\n  - `generateSearchIndex` (boolean): Generate `public/fuse.json` search index from `myst.xref.json` (default: `true`).\n  - `fuseConcurrency` (number): Concurrency used to fetch page JSON for fuse generation (default: `16`).\n  - `includeKeywords` (boolean): Include `frontmatter.keywords` in `fuse.json` entries (default: `false`).\n- `ProjectConfig`: Project configuration (configPath, staticConfig)\n- `MystCollectionsConfig`: Combined configuration for all collections\n\n#### Fuse search index (fuse.json)\n\nWhen `generateSearchIndex` is enabled, the XRef loader writes `public/fuse.json` containing a list of documents suitable for Fuse.js:\n\n```\n[\n  {\n    url: string,\n    kind: string,\n    identifier?: string,\n    frontmatter?: {\n      title?: string,\n      description?: string,\n  keywords?: string[] // included only when includeKeywords = true\n    }\n  }\n]\n```\n\nNotes:\n- For `kind: \"page\"`, the loader fetches the page `.json` (from the `data` field in `myst.xref.json`) to extract frontmatter.\n- Non-page references include `url`, `kind`, and (if present) `identifier`.\n- Entries missing a `url` or `kind` are skipped.\n- The file is saved under your working directory’s `public/` folder so Astro can serve it directly.\n - Use `fuseConcurrency` to tune throughput, and `includeKeywords` to opt-in keywords.\n\n \n\n## Requirements\n\n- Astro 5.0+\n- MyST content server running (typically on http://localhost:3100)\n- `@awesome-myst/myst-zod` for type definitions\n\n## License\n\nApache-2.0\n","readmeFilename":"README.md"}