https://github.com/protobuffet/docusaurus-protobuffet

Docusaurus toolset for Protobuf contract documentation.
https://github.com/protobuffet/docusaurus-protobuffet

documentation docusaurus protobuf rpc

Last synced: 3 months ago
JSON representation

Docusaurus toolset for Protobuf contract documentation.

• Host: GitHub
• URL: https://github.com/protobuffet/docusaurus-protobuffet
• Owner: protobuffet
• License: isc
• Created: 2021-02-06T23:11:09.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-02T10:20:38.000Z (over 1 year ago)
• Last Synced: 2024-11-10T19:45:06.723Z (3 months ago)
• Topics: documentation, docusaurus, protobuf, rpc
• Language: TypeScript
• Homepage: https://protobuffet.com
• Size: 2.84 MB
• Stars: 38
• Watchers: 2
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Docusaurus Protobuf Project

#### Visit the [landing page](https://protobuffet.com/) for Protobuffet documentation.

[Docusaurus](https://docusaurus.io/) toolset for Protobuf contract documentation. Provides a set of components and MDX doc file generators for Docusaurus sites.

This is a [Lerna](https://lerna.js.org/) project containing all packages.

## Usage

See [`docusaurus-protobuffet`](https://github.com/protobuffet/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet#usage) for details on usage.

See [`docusaurus-protobuffet-init`](https://github.com/protobuffet/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet-init#usage) to create a new Docusaurus project with this toolset installed.

## Features

### Existing

- React components for documenting Protobuf file descriptors including messages, services, and enums.

- Markdown doc (mdx) generation for the [Docusaurus platform](https://docusaurus.io/).

- Docusaurus sidebar object generation for a complete documentation workspace.

### Planned

- Extension support for generated sidebar and mdx files.

- Service implementation and client documentation.

### Demo

![Protodocs Overview](./screenshots/overview.png)

![Service Sample](./screenshots/overview-service.png)

Visit the [documentation site](https://protobuffet.com/docs/what/demo) for an interactive demo.

## Packages

### [`docusaurus-protobuffet`](https://github.com/protobuffet/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet)

Docusaurus preset to help mount the plugin and render all generated files.

### [`docusaurus-protobuffet-init`](https://github.com/protobuffet/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet-init)

Docusaurus project generator to scaffold a new site with these packages installed in a recommended setup.

### [`docusaurus-protobuffet-plugin`](https://github.com/protobuffet/docusaurus-protobuffet/tree/master/packages/docusaurus-protobuffet-plugin)

Docusaurus plugin containing the CLI commands, file generators, and components.

## Contributing

Contributions, issues and feature requests are always welcome!