{"_id":"@1password/docusaurus-plugin-stored-data","_rev":"4-038cdf7e3036ef5a2ab08ac1b4ed0d38","name":"@1password/docusaurus-plugin-stored-data","dist-tags":{"latest":"1.0.0"},"versions":{"0.1.0":{"name":"@1password/docusaurus-plugin-stored-data","description":"Load local or external data to be used in Docusaurus","version":"0.1.0","author":{"name":"1Password","email":"support@1password.com"},"repository":{"url":"git+https://github.com/1Password/docusaurus-extensions.git","type":"git","directory":"packages/docusaurus-plugin-stored-data"},"license":"MIT","engines":{"node":">=16.14"},"main":"dist/index.js","types":"src/plugin.d.ts","scripts":{"build":"yarn clean && tsc -p tsconfig.build.json","clean":"rimraf dist","test":"cd ../../ && yarn test --selectProjects=@1password/docusaurus-plugin-stored-data","typecheck":"tsc -p tsconfig.build.json --noEmit","watch":"tsc --build --watch --preserveWatchOutput"},"dependencies":{"@docusaurus/utils-validation":"^2.2.0","fast-xml-parser":"^4.0.11"},"devDependencies":{"@1password/jest-docusaurus":"workspace:^","@docusaurus/module-type-aliases":"^2.2.0","@docusaurus/types":"^2.2.0","@types/jest":"^28.1.8","@types/node":"^18.11.17","@types/react":"^18.0.25","rimraf":"^3.0.2","tslib":"^2.4.0","typescript":"^4.7.4"},"peerDependencies":{"@docusaurus/core":"^2.2.0","react":"^17.0.2","react-dom":"^16.8.4 || ^17.0.0"},"gitHead":"78ef1038016931433aefbb3ffe8f13ad623f94f6","bugs":{"url":"https://github.com/1Password/docusaurus-extensions/issues"},"homepage":"https://github.com/1Password/docusaurus-extensions#readme","_id":"@1password/docusaurus-plugin-stored-data@0.1.0","_nodeVersion":"16.19.0","_npmVersion":"lerna/5.6.2/node@v16.19.0+x64 (linux)","dist":{"integrity":"sha512-xw/5h4sHt+Oh9qkGH/NW/NcYWexouQDMSiePTeUEgX1e0SUC5KsiTsESlpWXM/uC15F0J3O7YNe3a8RQkw9osQ==","shasum":"7dca7cc909541b0bc37c1bb5d1d58d85f80c7326","tarball":"https://registry.npmjs.org/@1password/docusaurus-plugin-stored-data/-/docusaurus-plugin-stored-data-0.1.0.tgz","fileCount":13,"unpackedSize":16460,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAh8IFaXLQyIf17UD74NxjueDMmpqFJJuD8tTkNN53esAiADIpJ5Zw9vKyBFeTcj//nsAHYNTWGb39ueN0QnizLDsw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj5Ha7ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoX8w//fERwL7gM8RtIVqkiR3aWoBsatO/2aIxmfM2GlqpKo/nx+yyb\r\nPJGNi3o0l3tXSxpdJkgrH6UzPmy5Uq6ErwncrPfrrNM2v5e4ud/XCG8e80Pv\r\nQ4Tko5/7qD0dzvjtGB1T/TBE11faxfpKianQ92Hcsl1QEJGjgNtPrQCXTCrC\r\nGGYVRNiKqiZfhAbY54hukH/7S1rYlK9NyOBgXEXjVuddw6q5RvxKF3h/AT2N\r\nL6V0OXIbQxlBriwEY8TIgJvOmErUknQNL9ZlUssei4GjI3EWcy5LzwJ8Jh5L\r\nbQZZIIt8T5RCEEfKC1qznrqav7QDSzpMjyR58OhfTpNcDj0+EGXCpGINYJ9K\r\nIA/MpJ74kKt+cRydMl0WV4Bfr6iPWS7YXTJa7MZsahvup2gS/bmuPoAaa3Mn\r\nCJ6cj10JUPnQIMqcLbPvaWytnXdr63lOmlYbXqvZwcBbQs2K7UMp3s/AZul2\r\nyCHl8hl/O8C4h/HKBO53rGyWyHxbVsoT5cqpfoqshnjSFFpQ1CRAuPNFS09M\r\nvbj9CwO7/dS7LDdprDvmc8s73XujJjz8aqcsRdetZpPtaNga32i5WSxE9eP7\r\nlI4Qna+alGPQ/a+EhY2NPNSGQA5dJT9igHVMP1IC+DG0UfcEGoh0rCfXlFnV\r\n0pI2Wu0bP2HDYIOb6DdbhPVN+B09/f41VSc=\r\n=KVzU\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"onepassword","email":"npm@1password.com"},"directories":{},"maintainers":[{"name":"onepassword","email":"npm@1password.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docusaurus-plugin-stored-data_0.1.0_1675916986947_0.8710054519732295"},"_hasShrinkwrap":false},"1.0.0":{"name":"@1password/docusaurus-plugin-stored-data","description":"Load local or external data to be used in Docusaurus","version":"1.0.0","author":{"name":"1Password","email":"support@1password.com"},"repository":{"url":"git+https://github.com/1Password/docusaurus-extensions.git","type":"git","directory":"packages/docusaurus-plugin-stored-data"},"license":"MIT","engines":{"node":">=16.14"},"main":"dist/index.js","types":"src/plugin.d.ts","scripts":{"build":"yarn clean && tsc -p tsconfig.build.json","clean":"rimraf dist","test":"cd ../../ && yarn test --selectProjects=@1password/docusaurus-plugin-stored-data","typecheck":"tsc -p tsconfig.build.json --noEmit","watch":"tsc --build --watch --preserveWatchOutput"},"dependencies":{"@docusaurus/utils-validation":"^3.2.1","fast-xml-parser":"^4.0.11"},"devDependencies":{"@1password/jest-docusaurus":"workspace:^","@docusaurus/module-type-aliases":"^3.2.1","@docusaurus/types":"^3.2.1","@types/jest":"^29.5.12","@types/node":"^18.11.17","@types/react":"^18.2.0","rimraf":"^3.0.2","tslib":"^2.4.0","typescript":"^5.2.2"},"peerDependencies":{"@docusaurus/core":"^3.2.1","react":"^18.2.0","react-dom":"^18.2.0"},"gitHead":"b07e765ee6f261551b527be820259a875b27aa95","bugs":{"url":"https://github.com/1Password/docusaurus-extensions/issues"},"homepage":"https://github.com/1Password/docusaurus-extensions#readme","_id":"@1password/docusaurus-plugin-stored-data@1.0.0","_nodeVersion":"18.19.1","_npmVersion":"lerna/5.6.2/node@v18.19.1+x64 (linux)","dist":{"integrity":"sha512-UP0Hqzs4ji7n9Q1byomJ4kgyQhlGX9x3xPcaeNhDF4er5AzgfuL6vNFHh8p9x00391gQ0Zpwjrs9ua997oFe3w==","shasum":"8a26e7b14ac39b7cd782b0d44e7570d017b5130c","tarball":"https://registry.npmjs.org/@1password/docusaurus-plugin-stored-data/-/docusaurus-plugin-stored-data-1.0.0.tgz","fileCount":13,"unpackedSize":16522,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDG5fXMUHgaKlPTeZpjJnaNWgBycCC4LU1k14inopQ60wIhAPpUSe2JPUvY5vNGaKZp2fBEV8fLAiZdAXDFmJUYR/ti"}]},"_npmUser":{"name":"onepassword","email":"npm@1password.com"},"directories":{},"maintainers":[{"name":"onepassword","email":"npm@1password.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docusaurus-plugin-stored-data_1.0.0_1714503463965_0.28782112599078546"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-09T04:29:46.947Z","0.1.0":"2023-02-09T04:29:47.217Z","modified":"2024-04-30T18:57:44.336Z","1.0.0":"2024-04-30T18:57:44.102Z"},"maintainers":[{"name":"onepassword","email":"npm@1password.com"}],"description":"Load local or external data to be used in Docusaurus","homepage":"https://github.com/1Password/docusaurus-extensions#readme","repository":{"url":"git+https://github.com/1Password/docusaurus-extensions.git","type":"git","directory":"packages/docusaurus-plugin-stored-data"},"author":{"name":"1Password","email":"support@1password.com"},"bugs":{"url":"https://github.com/1Password/docusaurus-extensions/issues"},"license":"MIT","readme":"# docusaurus-plugin-stored-data\n\nLoad local or external data to be used in Docusaurus\n\n## Usage\n\nStart by installing the dependency:\n\n- Yarn: `yarn add @1password/docusaurus-plugin-stored-data`\n- NPM: `npm i @1password/docusaurus-plugin-stored-data`\n\nAdd the plugin to your `docusaurus.config.js` file's \"plugins\" option. If you're new to Docusaurus plugins, [click here to learn more](https://docusaurus.io/docs/using-plugins) about installing and configuring them.\n\nThese are the available plugin options:\n\n```ts\ntype Options = {\n /**\n * Define key-value pairs, where the key is the ID you want to assign to the data,\n * and the value is a local path or external URL to retrieve the data from.\n */\n data: Record;\n};\n```\n\nHere's an example of how to set the plugin's options, loading both local and external data:\n\n```js\n// docusaurus.config.js\nconst { resolve } = require(\"path\");\n\nplugins: [\n [\n '@1password/docusaurus-plugin-stored-data',\n {\n data: {\n \"blog-feed\": \"https://example.com/blog.xml\",\n \"rust-example\": resolve(__dirname, \"static\", \"example.rs\"),\n }\n }\n ]\n],\n```\n\nNow, when you start your dev server or build the site, the plugin will retrieve the contents of each location specified in the config and store it as plugin data. Access this data in your site using one of the plugin's hooks, which takes the ID and returns the data in various formats.\n\nThe following hooks are available:\n\n- `@theme/useStoredData` - Returns the data unformatted\n- `@theme/useStoredJson` - Returns the data parsed as JSON\n- `@theme/useStoredFeed` - Returns the data parsed as RSS XML into JSON structure using [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser).\n\nHere's an example of how you might use the plugin to retrieve and render blog posts from an RSS feed:\n\n```jsx\n// FeedItems.tsx\n\nimport useStoredFeed from \"@theme/useStoredFeed\";\n\nconst FeedItems = () => {\n const feedData = useStoredFeed(\"blog-feed\");\n return (\n \n );\n};\n```\n\nOr, if your data can be rendered without modification you can simply call a hook directly inside an MDX file:\n\n```jsx\n// example.mdx\n\nimport CodeBlock from \"@theme/CodeBlock\";\nimport useStoredData from \"@theme/useStoredData\";\n\n{useStoredData(\"rust-example\")};\n```\n\nIf you're using TypeScript you will need to reference the plugin's types:\n\n```ts\n// types.d.ts\n\n/// \n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}