Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@mikaello/avrodoc-plus

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mikaello/avrodoc-plus

Documentation tool for Avro schemas. Forked from https://github.com/leosilvadev/avrodoc-plus.

  • 1.0.1
  • npm
  • Socket score

Version published
Weekly downloads
802
increased by2.17%
Maintainers
1
Weekly downloads
 
Created
Source

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

Enhancements

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

FAQs

Package last updated on 24 Apr 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc