Display JavaDocs on GitHub

java github javadoc markdown
Phil picture Phil · Mar 11, 2013 · Viewed 21.9k times · Source

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.

Answer

Emmanuel Bourg picture Emmanuel Bourg · Mar 12, 2013

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/

Related questions

Loading Maven dependencies from GitHub

How do I add a Java library from its GitHub repo (the library uses Maven as a build system) as a dependency to my Maven project? Can I do that without downloading and compiling the library?

Read More
Android Showcase View how to use?

Well For Showcase View I using this: https://github.com/amlcurran/ShowcaseView After importing files it gives error. this is my errors and improted .jar files Errors says in java R cannot be resolved to a variable in style error: …

Read More
Committing fails in Git hooks pre-commit because the node command wasn't found

I generated a JHipster app with Angular and Java, inside of a repository that I had previously made. I then generated some JDL classes with it and the build was successful, but when I tried to commit my changes in …

Read More