docusaurus-protobuffet-plugin
v0.3.3
Published
Protobuf documentation plugin for Docusaurus
Downloads
3,769
Maintainers
Readme
Docusaurus Protobuf Plugin
Visit the landing page for Protobuffet documentation.
Docusaurus plugin for Protobuf contract documentation. Provides a set of components and MDX doc file generators for Docusaurus sites.
See docusaurus-protobuffet
for details on usage.
Configuration
This plugin accepts the following options. These options are passed through docusaurus-protobuffet
preset's protobuffet
option with some defaults applied.
| Option | Description | Required | Example |
| --- | --- | --- | --- |
| fileDescriptorsPath
| Path to JSON file containing generated proto documentation through protoc-gen-doc. See docusaurus-protobuffet
usage for details. | ✅ | ./fixtures/proto_workspace.json
|
| protoDocsPath
| Directory where CLI will create doc files. | ✅ | ./protodocs
|
| sidebarPath
| Path to file where CLI will write the generated Sidebar object. | ✅ | ./sidebarsProtodocs.js
|
Contributing
Contributions, issues and feature requests are always welcome!