@mikaello/avrodoc-plus

avrodoc-plus

avrodoc-plus is a documentation tool for Apache Avro schemas.

This project originates from ept/avrodoc -> ckatzorke/avrodoc-plus -> leosilvadev/avrodoc-plus, which are all great, but receives no further updates.

Usage

npm install --global @mikaello/avrodoc-plus | yarn add global @mikaello/avrodoc-plus
avrodoc-plus -i source -o out.html

Or without installation:

npx @mikaello/avrodoc-plus -i source -o out.html

Options

• -i sourcefolder
  Pass in a source folder that will recursively parsed and crawled for avsc files
• -o outputfile
  The file where the generated doc should be written to
• -s external stylesheet less file
  Your own less file, used to override specific style of your generated page
• --ignore-invalid
  Ignore avsc files that can not be parsed as JSON (instead of quiting)

Enhancements

• support for input folders
• support of schema/type search (search by namespace and/or schema/type)