How to publish versioned JavaDoc/Site to github pages in Java project?

leventov

If a project is named foo, I want to publish Javadocs for different versions separate directories, like:

me.github.io/foo/1.0/apidocs/
me.github.io/foo/2.0/apidocs/

The similar problem is discussed here: https://github.com/github/maven-plugins/issues/22 but it doesn't seem that the problem is solved

John McClean

I use javadoc.io for hosting javadoc for my open source projects on Github, and then link to that from the readme.md and github pages (e.g. here is the javdoc for the latest version of one of my projects : http://www.javadoc.io/doc/com.aol.simplereact/simple-react/0.99.2).

It's simple enough to set up. Once you've released to Maven Central or bintray (including your sources) browse to

http://www.javadoc.io/doc/<group id>/<artefact id>/<version>

That will get your library added to the system and it should download the javadoc and add it to the site within a day (sometimes immediately).

It's better than managing the process yourself, and it is guaranteed to match the actual version of the code that people are using (and the source they'll see in their IDEs), as it is downloaded from the same version repo in Maven Central. (If you manage your own, the possibility of uploading subtely different versions to Maven Central and your hosting site emerges).

Collected from the Internet

Please contact [email protected] to delete if infringement.

edited at
0

Comments

0 comments
Login to comment

Related

How publish java project in github?

how to publish to github pages?

How to publish Delphi project on Github?

How to publish a Ionic 5 website on GitHub pages?

Angular 7 project doesn't publish on Github - shows only ReadMe file (I've used GitHub Pages)

How to publish a website made by Node.js to Github Pages?

What are Github Project Pages and how to use them?

How to configure DNS to point to github project pages?

publish dist folder to github pages

how do i publish a organization project to github with intellij

How to publish 2nd project through Github

build and publish dist folder to github pages

How to set up project pages as subpages of GitHub personal webpage?

How to deploy a project on GitHub Pages from dist folder

How do you publish a typescript website to GitHub Pages using Visual Studio?

How do I resolve dart pub publish vs github pages doc directories conflict?

Custom domain for GitHub project pages

Subdomain of website for Github pages project

Publish React app to Github Pages using github Actions

Publish website without project name on github

How to contribute to open source project in Java on GitHub

How to deploy java project on github to Azure

How to use theme from github.io site for Github Project Pages sites

Github Pages: How to access github project page when root site is jekyll

How can I publish a project to GitHub without my repository's version control history?

How to import a GitHub hosted project as a Java Project in Eclipse?

How to publish laravel project on internet?

How to publish an aurelia project in IIS

Angular project working on localhost but not on GitHub Pages