Phil Phil - 1 year ago 194
Markdown Question

Display JavaDocs on GitHub

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

directory). Is there a simple solution for this? Can I simply point the GitHub
to my
directory? Is there something more elegant? I have been striking out on Google.

Answer Source

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. It will be available at :

Here is an example from one of my projects:

Recommended from our users: Dynamic Network Monitoring from WhatsUp Gold from IPSwitch. Free Download