{"_id":"@akurdyukov/docusaurus-protobuffet-init","name":"@akurdyukov/docusaurus-protobuffet-init","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@akurdyukov/docusaurus-protobuffet-init","version":"1.0.0","description":"Create Docusaurus projects with Protobuffet preset enabled","author":{"name":"Anthony Bobsin","email":"bobsinj@gmail.com"},"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-init","keywords":["docusaurus","plugin","protobuf","documentation","api","protocol buffers","grpc","microservices","markdown","mdx"],"engines":{"node":">=18.0.0"},"main":"dist/index.js","bin":{"docusaurus-protobuffet-init":"bin/index.js"},"scripts":{"build":"tsc && npm run copy-template-fixtures","test":"echo \"Error: run tests from root\" && exit 1","start":"node dist/index.js","copy-template-fixtures":"copyfiles -u 2 \"src/templates/**/*\" dist/templates/"},"dependencies":{"chalk":"^4.1.0","commander":"^7.2.0","shelljs":"^0.8.4"},"publishConfig":{"access":"public"},"devDependencies":{"@types/node":"^20.0.0","@types/shelljs":"^0.8.8","copyfiles":"^2.4.1"},"gitHead":"13ea1a31c27835bb08f903dd9fb7ad8fe51066bf","_id":"@akurdyukov/docusaurus-protobuffet-init@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-9VT2sZIgAvBKru8A4XjhCU0E2HZAgaLg90IYQqAsTMnx6iuZpmPhwLxrr3+4syyjy+A/im8MdZDDCbsevky7fQ==","shasum":"18f60de5081912072fab32672172dd99ccda3b89","tarball":"https://registry.npmjs.org/@akurdyukov/docusaurus-protobuffet-init/-/docusaurus-protobuffet-init-1.0.0.tgz","fileCount":35,"unpackedSize":127898,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIBzqaGHSTMULCOhJtBEeXw9VkeZzPy7cIeuWJeq9C/XtAiEAo7x6DIxslzljFTIjXnyk8G5XiICJa07YDBhjYTlYIjE="}]},"_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-init_1.0.0_1770673824856_0.6785856036444051"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-09T21:50:24.780Z","1.0.0":"2026-02-09T21:50:25.001Z","modified":"2026-02-09T21:50:25.209Z"},"maintainers":[{"name":"akurdyukov","email":"akurdyukov@gmail.com"}],"description":"Create Docusaurus projects with Protobuffet preset enabled","homepage":"https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet-init","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","email":"bobsinj@gmail.com"},"bugs":{"url":"https://github.com/akurdyukov/docusaurus-protobuffet/issues"},"license":"ISC","readme":"# Docusaurus Project Generator with Protobuffet Preset\n\n#### Visit the [landing page](https://protobuffet.com/) for Protobuffet documentation.\n\nExecutable project generator based on [`create-docusaurus`](https://docusaurus.io/docs/installation). This generator enhances the common template by also initializing the [`@akurdyukov/docusaurus-protobuffet`](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet) preset with recommended options and sample fixtures.\n\nSee [`@akurdyukov/docusaurus-protobuffet`](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#usage) for details on this preset.\n\nSee [Docusaurus docs](https://docusaurus.io/docs/installation#scaffold-project-website) for details on the common template.\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## Usage\n\nThis package scaffolds a new Docusaurus project with the `@akurdyukov/docusaurus-protobuffet` preset pre-configured. If you already have an existing Docusaurus project, use [`@akurdyukov/docusaurus-protobuffet`](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#installation) directly instead.\n\n**Requirements:** Node.js 18+, npm 9+\n\n### Registry Setup\n\nThis package is published to the GitHub npm registry. Configure npm to use it for the `@akurdyukov` scope by adding the following to an `.npmrc` file in your project directory or home directory (`~/.npmrc`):\n\n```\n@akurdyukov:registry=https://npm.pkg.github.com\n```\n\nIf the repository is private, you also need to authenticate. Create a GitHub [personal access token](https://github.com/settings/tokens) with `read:packages` scope and add it:\n\n```\n//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN\n```\n\n### Quick Start\n\nRun the generator from the parent directory where you want the project created:\n\n```sh\nnpx @akurdyukov/docusaurus-protobuffet-init@1 init <project_name>\n```\n\nThis will:\n1. Scaffold a Docusaurus project using `create-docusaurus` with the classic template\n2. Install `@akurdyukov/docusaurus-protobuffet` and `@easyops-cn/docusaurus-search-local`\n3. Copy Protobuffet config, sample fixtures, and landing page templates\n4. Run `generate-proto-docs` to generate documentation from the sample fixtures\n\nOnce complete, start the development server:\n\n```sh\ncd <project_name>\nnpm run start\n```\n\n### Regenerating Proto Docs\n\nWhenever you update the `fileDescriptorsPath` file (defaults to `./fixtures/proto_workspace.json`), regenerate the documentation:\n\n```sh\nnpx docusaurus generate-proto-docs\n```\n\nSee the [`@akurdyukov/docusaurus-protobuffet` CLI documentation](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#cli-commands) for details.\n\n### Deployment\n\nThis is a standard Docusaurus project. Follow the [Docusaurus deployment docs](https://docusaurus.io/docs/deployment) for production builds and hosting.\n\n## Configuration\nThe default setup configures `fileDescriptorsPath` to `./fixtures/proto_workspace.json`. You can override this with your own Protobuf workspace file or update the options passed to `@akurdyukov/docusaurus-protobuffet` within your `docusaurus.config.js` file. Please see [`@akurdyukov/docusaurus-protobuffet` documentation](https://github.com/akurdyukov/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#configuration) for details.\n\nThe navbar configuration within `docusaurus.config.js` points to one of the generated files of the sample fixture. You will need to update this route when using your own Protobuf workspace file.\n\n## Contributing\n\nContributions, issues and feature requests are always welcome!\n","readmeFilename":"README.md","_rev":"1-96e2e9b92f755488aa5bd1e2429df1fa"}