binx-suse / javadoccentral

JavaDoc Central

Artifacts in Maven Central typically provide a JavaDoc Jar that contains the versioned documentation for the artifact. While IDEs use this to display the docs for a library, it is also sometimes nice to browse the docs in a web browser. This project is a simple web app that allows you to view the JavaDoc for any artifact in Maven Central.

Usage Guide:

Main page: javadocs.dev

URL Format: https://javadocs.dev/GROUP_ID/ARTIFACT_ID/VERSION

You can specify the GROUP_ID, ARTIFACT_ID, and VERSION, like:
https://javadocs.dev/org.webjars/webjars-locator/0.32

Or the GROUP_ID and ARTIFACT_ID, like:
https://javadocs.dev/org.webjars/webjars-locator

Or just the GROUP_ID, like:
https://javadocs.dev/org.webjars

You can also specify latest for the version, like:
https://javadocs.dev/org.webjars/webjars-locator/latest

Dev Info

Run with restart:

./sbt ~reStart

Run and output GraalVM configs, with GraalVM:

# uncomment javaOptions in build.sbt
./sbt run

Create native image, with GraalVM:

./sbt graalvm-native-image:packageBin

Build the container:

docker build -t javadoccentral .

Run the container:

docker run -p8080:8080 javadoccentral