Skip to main content

Features

Protobuffet leverages the Docusaurus platform to help build documentation for your Protobuf workspace.

Existing Features​

  • React components for documenting Protobuf file descriptors. Component library includes message, service, and enum views.
  • Protobuffet CLI to generate markdown (.mdx) files based on a Protobuf file workspace.
  • Docusaurus sidebar object generation for a navigatable documentation workspace.
  • Docusaurus project scaffolder to initialize a new project with Protobuffet installed.

Planned Features​

  • Extension support for generated sidebar and markdown files.
  • Service implementation and client documentation.