如何在 Java 项目中将版本化 JavaDoc/Site 发布到 github 页面?
How to publish versioned JavaDoc/Site to github pages in Java project?
如果项目名为foo
,我想为不同版本的单独目录发布Javadocs,如:
me.github.io/foo/1.0/apidocs/
me.github.io/foo/2.0/apidocs/
这里讨论了类似的问题:https://github.com/github/maven-plugins/issues/22但是好像没有解决问题
我用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).
设置起来非常简单。一旦你发布到 Maven Central 或 bintray(包括你的源代码)浏览到
http://www.javadoc.io/doc/<group id>/<artefact id>/<version>
这会将您的图书馆添加到系统中,它应该下载 javadoc 并在一天内(有时立即)将其添加到站点中。
这比自己管理流程要好,而且它保证与人们使用的代码的实际版本(以及他们将在他们的 IDE 中看到的源代码)相匹配,因为它是从同一版本下载的在 Maven 中心回购。 (如果您自己管理,则可能会出现将细微不同的版本上传到 Maven Central 和您的托管站点的可能性)。
如果项目名为foo
,我想为不同版本的单独目录发布Javadocs,如:
me.github.io/foo/1.0/apidocs/
me.github.io/foo/2.0/apidocs/
这里讨论了类似的问题:https://github.com/github/maven-plugins/issues/22但是好像没有解决问题
我用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).
设置起来非常简单。一旦你发布到 Maven Central 或 bintray(包括你的源代码)浏览到
http://www.javadoc.io/doc/<group id>/<artefact id>/<version>
这会将您的图书馆添加到系统中,它应该下载 javadoc 并在一天内(有时立即)将其添加到站点中。
这比自己管理流程要好,而且它保证与人们使用的代码的实际版本(以及他们将在他们的 IDE 中看到的源代码)相匹配,因为它是从同一版本下载的在 Maven 中心回购。 (如果您自己管理,则可能会出现将细微不同的版本上传到 Maven Central 和您的托管站点的可能性)。