Visit the landing page for Protobuffet documentation.
Docusaurus toolset for Protobuf contract documentation. Provides a set of components and MDX doc file generators for Docusaurus sites.
This is a Lerna project containing all packages.
See docusaurus-protobuffet for details on usage.
See docusaurus-protobuffet-init to create a new Docusaurus project with this toolset installed.
- React components for documenting Protobuf file descriptors including messages, services, and enums.
- Markdown doc (mdx) generation for the Docusaurus platform.
- Docusaurus sidebar object generation for a complete documentation workspace.
- Extension support for generated sidebar and mdx files.
- Service implementation and client documentation.
Visit the documentation site for an interactive demo.
Docusaurus preset to help mount the plugin and render all generated files.
Docusaurus project generator to scaffold a new site with these packages installed in a recommended setup.
Docusaurus plugin containing the CLI commands, file generators, and components.
Contributions, issues and feature requests are always welcome!