Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 638 Bytes

README.md

File metadata and controls

22 lines (15 loc) · 638 Bytes

avrodoc-plus

avrodoc-plus is a documentation tool for Apache Avro schemas.
This project originates from https://github.com/ept/avrodoc, which is great, but received no further updates.

Usage

npm install --global @ckatzorke/avrodoc-plus | yarn add global @ckatzorke/avrodoc-plus
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

Enhancements

  • support for input folders