Skip to content
This repository has been archived by the owner on Apr 27, 2022. It is now read-only.
/ Javadoc-Proxy Public archive

A small proxy written in NodeJS used to easily access JavaDocs for Javacord.

License

Notifications You must be signed in to change notification settings

Javacord/Javadoc-Proxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Javacord JavaDoc Proxy

A small proxy written in NodeJS used to easily access JavaDocs for Javacord.

I just want to use Javacord :(

In this case you are wrong here. Just head over to the Javacord repository.

What does this do?

Javacord's Teamcity server (https://ci.javacord.org/) generates JavaDocs for every commit on GitHub and every released version. These links aren't that easy to access though, as they look like this:

https://ci.javacord.org/repository/download/Javacord_PublishSnapshots/3853:id/javacord-api/javacord-api-3.0.0-SNAPSHOT-javadoc.jar%21/overview-summary.html

This proxy "coverts" these ugly urls into more user-friendly ones like this:

https://docs.javacord.org/api/build/3853

How to run it?

If you want to run this yourself for whatever reason, you can use Docker:

git clone https://github.com/Javacord/Javadoc-Proxy.git
cd Javadoc-Proxy
docker build -t javadoc_proxy .
docker run --rm -d -p 8080:80 --name javadoc_proxy javadoc_proxy

About

A small proxy written in NodeJS used to easily access JavaDocs for Javacord.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published