Skip to content
This repository has been archived by the owner on Oct 18, 2022. It is now read-only.

valery1707/javadoc-badge

Repository files navigation

Build Status Build status Build status Build status Build Status Dependency Status

Stories in Ready Issue Stats Issue Stats

GitHub tag

Simple Javadoc badge that automatically detect current artifact version, deployed to Maven Central and create badge showing that version with Shields.io.

API

URL: http://javadoc-emblem.rhcloud.com/doc/${groupId}/${artifactId}/badge.${ext}

  • groupId and artifactId describe maven artifact information
  • ext - supported extensions from Shields.io, eg svg or png

Also exists some optional params:

  • style - supported styles from Shields.io
  • color - supported colors from Shields.io
  • subject - text for first part of badge (default: javadoc)
  • prefix - prefix for version in badge
  • suffix - suffix for version in badge
Examples
  • Spring Core: Javadoc ![Javadoc](http://javadoc-emblem.rhcloud.com/doc/org.springframework/spring-core/badge.svg)
  • Scala Library: Javadoc ![Javadoc](http://javadoc-emblem.rhcloud.com/doc/org.scala-lang/scala-library/badge.svg)
  • Lamma: Javadoc ![Javadoc](http://javadoc-emblem.rhcloud.com/doc/io.lamma/lamma_2.11/badge.svg)
Version providers

Actual version detected from Javadoc.io and cached 2 hours.