Avro Docs 2.0

Avro Docs 2.0 is a web app to display for Avro schema documentation.

This project was bootstrapped with Create React App and it was inspired by https://github.com/ept/avrodoc.

Checkout it out live on Github pages.

How to use

You need node.js installed. I've tested this with Node 18.

Clone the repo

$ gitclone [email protected]:arminhaghi/avro-docs-2.0.git

Copy your avsc files to ./public/avro/

$ npm install
$ npm run build

Deploy content of the build folder to your web server.

Notes:

• Since this project was bootstrapped using Create React App it requires a web server to serve the content. It's also uses clinet side routing using React Router.

• The live example is deployed using the guide above for github pages.

• The application expect the folder structure of the avro files to match the filenamespace, otherwise it won't find the schema to load. In the live example, the content of the ./public/avro folder is the following:

.\public\avro\com\example\internal\User.avsc
.\public\avro\com\example\Person.avsc

Here is more information of how you can deploy this app.

Features

• React
• Excellent for getting an overview of a complex schema with many nested records
• Renders documentations as Markdown.

Todo

• Add Unit Test

Contribution

This is a work in progress. Pull requests are welcome.