Comment utiliser le markdown pour le site du projet maven?

Comment démarrer avec la documentation du projet en utilisant le langage de balisage Maven et Markdown? Le site Maven par défaut est APT, ce qui est inconfortable d’apprendre à faire quelque chose de manière maven. (Habituellement, personne dans une équipe ne commencera à écrire de la documentation sur le site Maven quand ils devront également apprendre un autre langage de balisage en cours de route.)

Quelqu’un a-t-il essayé d’utiliser le markdown (le même langage de balisage que celui utilisé sur github) pour la documentation du site de projet Maven? Je vois des références de Maven Doxia que c’est possible. Quelque problème que ce soit?

Je suis nouveau sur la génération de site de Maven. Je pense que le markdown est préférable aux autres langages de balisage avec lesquels l’équipe n’a pas travaillé.

METTRE À JOUR. Réussi. Voir la réponse ci-dessous.

Citation de http://maven.apache.org/doxia/references/index.html

Ajoutez ceci à pom.xml

   org.apache.maven.plugins maven-site-plugin 3.2   org.apache.maven.doxia doxia-module-markdown 1.3    

Ensuite, commencez à append des pages sous src/site/markdown/ avec l’extension .md . Pour chaque page append un élément de menu comme dans sniplet ci-dessous:

         

Que d’utiliser le mvn site pour générer le site. Regardez la target/site pour examiner les résultats.

mvn site:stage -DstagingDirectory=C:\TEMP\fullsite pour obtenir un site de projet multi-modulaire dans un dossier.

En savoir plus sur maven-site-plugin .

Je recommande d’utiliser maven-fluido-skin . C’est le style le plus récent, basé sur Twitter Bootstrap Ajouter ceci à site.xml

  [...]  org.apache.maven.skins maven-fluido-skin 1.3.0  [...]  

Voir aussi https://github.com/winterstein/Eclipse-Markdown-Editor-Plugin

Une autre méthode standard consiste à utiliser le plug-in de site Maven comme suit:

Avec cette approche, vous pouvez tirer parti du filtrage du moteur de modèles de vitesse. Donc, cela ajoute plus de puissance à votre documentation.