Git Product home page Git Product logo

avrodoc-plus's Introduction

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)

avrodoc-plus's People

Contributors

ckatzorke avatar ept avatar leosilvadev avatar mphuff avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.