Skip to content
This repository was archived by the owner on Nov 11, 2025. It is now read-only.

hexmont/Spigot-JavaDoc-Downloader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 

Repository files navigation

Spigot JavaDocs Downloader


Notice: Repository Migration

All my active development has moved to git.alemonta.dev — my self-hosted Gitea instance.

Repositories on GitHub are now archived and will no longer receive updates.

You can find this project @ git.alemonta.dev/alemontamd5/spigot-javadoc-downloader.git

You can find current and continued projects at:

➡️ https://git.alemonta.dev/alemontamd5


This is a simple Java 17 project that allows users to download all the JavaDocs for Spigot, a popular Minecraft server API. It's being done in rush, so don't complain too much about code quality <3

This tool streamlines the process of obtaining the JavaDocs from the Sonatype Nexus Repository, making it easier for developers to reference the documentation offline.

Features

  • Downloads all JavaDocs for the Spigot API
  • Simple command-line interface
  • Written in Java 17

Prerequisites

  • Java 17 or higher installed on your machine (and set to your PATH)

Installation

You can either:

Download the .jar and run

To download locally all the javadocs, simply download the latest release and execute the jar with java -jar spigot-api-javadocs-downloader-v1.0.jar.

After downloading all the javadocs your default browser will open a new window to the index.html (~\javadocs).

Clone the repository, compile, and run

To download locally all the javadocs, simply run all the commands in the correct order into your terminal.

After downloading all the javadocs your default browser will open a new window to the index.html (~\Spigot-JavaDoc-Downloader\javadocs).

git clone https://github.com/SadShrimpyy/Spigot-JavaDoc-Downloader.git
mkdir Spigot-JavaDoc-Downloader/build
cd Spigot-JavaDoc-Downloader/src
javac -d ../build Main.java && cd .. && java -cp build Main

TODO List / Known issues

  1. As now if you run more than once, this tool will download again all the javadocs. If you have already, just skip! DONE

About

Simple Java 17 project that allow you to download all the Spigot's JavaDocs

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages