编程语言
首页 > 编程语言> > 如何在Java项目中将版本化的JavaDoc / Site发布到github页面?

如何在Java项目中将版本化的JavaDoc / Site发布到github页面?

作者:互联网

如果项目名为foo,我想为不同版本的单独目录发布Javadoc,例如:

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

这里讨论类似的问题:https://github.com/github/maven-plugins/issues/22但似乎问题没有解决

解决方法:

我在Github上使用javadoc.io为我的开源项目托管javadoc,然后从readme.md和github页面链接到那个(例如这里是我的一个项目的最新版本的javdoc:http://www.javadoc.io/doc/com.aol.simplereact/simple-react/0.99.2).

设置起来很简单.一旦你发布到Maven Central或bintray(包括你的资源)浏览到

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

这将使您的库添加到系统中,它应该下载javadoc并在一天内(有时立即)将其添加到站点.

它比自己管理流程更好,并且保证与人们正在使用的代码的实际版本(以及他们在IDE中看到的源代码)相匹配,因为它是从Maven Central中的相同版本仓库下载的. (如果您自己管理,可能会将不同版本上传到Maven Central和您的托管网站).

标签:java,maven,github,github-pages
来源: https://codeday.me/bug/20190722/1504117.html