Afficher JavaDocs sur GitHub
Je cherche un moyen de convertir les javadocs de mon projet open source (généré dans Eclipse ) en Github MarkDown , ou de trouver une autre solution simple pour afficher ma documentation sur GitHub (timide de simplement ajouter un répertoire docs). Est-il une solution simple pour cela? Puis-je simplement pointer le github README.md dans mon répertoire docs? Est-il quelque chose de plus élégant? J'ai été frappant sur Google .
2 réponses
Je ne pense pas qu'il soit possible de faire un Javadoc utilisable avec MarkDown. La meilleure solution est probablement de valider le Javadoc que vous avez généré sur la branche gh-pages (ou dans le répertoire docs/ en fonction des paramètres de votre projet). Il sera disponible à:
Http://username.github.io/projectname
Voici un exemple d'un de mes projets:
Actuellement, vous pouvez également héberger votre Javadoc avec Github Pages non seulement d'une gh-pages branche, mais directement à partir de la /docs dossier au sein de votre master branche. Vous pouvez consulter la section d'aide sur ce sujet, ici (aussi vérifier image jointe ci-dessous).
En outre, il y a un projet sur Github qui cible une certaine conversion de Javadoc en Markdown (Je ne l'ai pas encore essayé, juste en laissant la référence).