在GitHub上显示JavaDocs [英] Display JavaDocs on GitHub

问题描述

我正在寻找一种将 javadocs 从我的开源项目(在 Eclipse 中生成)转换为 GitHub MarkDown 的方法，或者提出了一些其他简单的解决方案，以在 GitHub 上显示我的文档(为什么要简单地添加docs目录).有一个简单的解决方案吗?我可以简单地将 GitHub README.md指向我的docs目录吗?还有更优雅的东西吗?我一直在 Google 上大放异彩.

I'm looking for a way to convert the javadocs from my open source project (generated in Eclipse) to GitHub MarkDown, or come up with some other simple solution to display my documentation on GitHub (shy of simply adding a docs directory). Is there a simple solution for this? Can I simply point the GitHub README.md to my docs directory? Is there something more elegant? I have been striking out on Google.

推荐答案

我认为用MarkDown制作可用的Javadoc是不可能的.最好的解决方案可能是提交您在gh-pages分支(或在docs/目录中，具体取决于项目设置)中生成的Javadoc.它将在以下位置提供:

I don't think it's possible to make a usable Javadoc with MarkDown. The best solution is probably to commit the Javadoc you generated on the gh-pages branch (or in the docs/ directory depending on the settings of your project). It will be available at :

http://username.github.io/projectname

这是我的一个项目的示例:

Here is an example from one of my projects:

http://ebourg.github.io/jsign/apidocs/

这篇关于在GitHub上显示JavaDocs的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！