{"_id":"@akurdyukov/docusaurus-protobuffet-plugin","name":"@akurdyukov/docusaurus-protobuffet-plugin","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@akurdyukov/docusaurus-protobuffet-plugin","version":"1.0.0","description":"Protobuf documentation plugin for Docusaurus","author":{"name":"Anthony Bobsin"},"license":"ISC","repository":{"type":"git","url":"git+https://github.com/akurdyukov/docusaurus-protobuffet.git"},"homepage":"https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet-plugin","keywords":["docusaurus","plugin","protobuf","documentation","api","protocol buffers","grpc","microservices","markdown","mdx"],"engines":{"node":">=18.0.0"},"main":"dist/index.js","scripts":{"build":"tsc","test":"echo \"Error: no test specified\" && exit 1"},"dependencies":{"@docusaurus/utils":"^3.9.2"},"devDependencies":{"@types/react":"^19.0.0","react":"^19.0.0"},"publishConfig":{"access":"public"},"gitHead":"13ea1a31c27835bb08f903dd9fb7ad8fe51066bf","_id":"@akurdyukov/docusaurus-protobuffet-plugin@1.0.0","bugs":{"url":"https://github.com/akurdyukov/docusaurus-protobuffet/issues"},"_nodeVersion":"24.12.0","_npmVersion":"lerna/9.0.3/node@v24.12.0+arm64 (darwin)","dist":{"integrity":"sha512-pJCNKfmIce7pZAh6F+yV4SJKA3LKaVy5hZBasXRNxTilHhrEXG3N0Sl8KZpdaX0vh8aDFztSLVdFzt+NrQEPMQ==","shasum":"b3c544c0987a791cfdd28aabdacb7d1342d71e40","tarball":"https://registry.npmjs.org/@akurdyukov/docusaurus-protobuffet-plugin/-/docusaurus-protobuffet-plugin-1.0.0.tgz","fileCount":20,"unpackedSize":39376,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICTzje4laN6UpQXRRWjdNztJtY+uLWetOpP3Cj/0StT+AiAq9nujGIF3orusYAMp+byU+F7LB8Hf/ECUELVzQKnU/Q=="}]},"_npmUser":{"name":"akurdyukov","email":"akurdyukov@gmail.com"},"directories":{},"maintainers":[{"name":"akurdyukov","email":"akurdyukov@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/docusaurus-protobuffet-plugin_1.0.0_1770673824919_0.5690524622864479"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-09T21:50:24.824Z","1.0.0":"2026-02-09T21:50:25.082Z","modified":"2026-02-09T21:50:25.268Z"},"maintainers":[{"name":"akurdyukov","email":"akurdyukov@gmail.com"}],"description":"Protobuf documentation plugin for Docusaurus","homepage":"https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet-plugin","keywords":["docusaurus","plugin","protobuf","documentation","api","protocol buffers","grpc","microservices","markdown","mdx"],"repository":{"type":"git","url":"git+https://github.com/akurdyukov/docusaurus-protobuffet.git"},"author":{"name":"Anthony Bobsin"},"bugs":{"url":"https://github.com/akurdyukov/docusaurus-protobuffet/issues"},"license":"ISC","readme":"# Docusaurus Protobuf Plugin\n\n#### Visit the [landing page](https://protobuffet.com/) for Protobuffet documentation.\n\n[Docusaurus](https://docusaurus.io/) plugin for Protobuf contract documentation. Provides a set of components and MDX doc file generators for Docusaurus sites.\n\nSee [`@akurdyukov/docusaurus-protobuffet`](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#usage) for details on usage.\n\n## Compatibility\n\n| Version | Docusaurus | React | Node.js |\n|---------|-----------|-------|---------|\n| 1.x     | 3.9+      | 18+   | 18+     |\n| 0.x     | 2.x       | 17    | 14+     |\n\n---\n\n## Configuration\n\nThis plugin accepts the following options. These options are passed through [`@akurdyukov/docusaurus-protobuffet`](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#configuration) preset's `protobuffet` option with some defaults applied.\n\n| Option | Description | Required | Example |\n| --- | --- | --- | --- |\n| `fileDescriptorsPath` | Path to JSON file containing generated proto documentation through [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc). See [`docusaurus-protobuffet` usage](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#generating-the-filedescriptorspath-file) for details. | ✅ | `./fixtures/proto_workspace.json` |\n| `protoDocsPath` | Directory where CLI will create doc files. | ✅ | `./protodocs` |\n| `sidebarPath` | Path to file where CLI will write the generated Sidebar object. | ✅ | `./sidebarsProtodocs.js` |\n\n## Contributing\n\nContributions, issues and feature requests are always welcome!\n","readmeFilename":"README.md","_rev":"1-50ee6c0c62f813075a1a27e6bf0c00ec"}