Skip to content

mobimeo/avrodoc-plus

 
 

Repository files navigation

avrodoc-plus

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

Usage

npm install --global @mobimeo/avrodoc-plus | yarn add global @mobimeo/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
  • -s external stylesheet less file
    Your own less file, used to override specific style of your generated page

Enhancements

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

About

Documentation tool for Avro schemas

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 76.8%
  • Less 23.2%