Comment utiliser markdown pour projet maven site?

Comment démarrer avec la documentation du projet à l'aide de maven et langage de balisage markdown?
Maven site par défaut est d'APT, qui est mal à l'aise pour apprendre juste à faire chose maven façon.
(Généralement personne dans une équipe de commencer à écrire maven site de la documentation lorsqu'ils doivent aussi apprendre un plus de langage de balisage le long du chemin.)

Personne n'a essayé d'utiliser markdown (le même langage de balisage utilisé sur github) pour le projet Maven site de la documentation? Je vois de Maven Doxia références que c'est possible.
Toutes les questions?

Je suis nouveau sur maven site génération. Je pense que markdown est préférable de commencer avec, que d'autres langages de balisage, que l'équipe n'a pas travaillé.

Mise à JOUR. Réussi. Voir la réponse ci-dessous.

  • Pas encore de. J'ai prévu de le faire avant la fin du mois de février. Je vais poster ma propre réponse ici, si personne ne répond.
  • Le lien que tu a posté toutes les informations dont vous avez besoin. Je vais marquer cette question à être fermé dans le temps de le dire. Merci de poster si vous avez une question plus spécifique lorsque vous essayez de générer la documentation avec md.
  • Dans Maven la valeur par défaut est apt oder xdoc format ...actuellement, il n'existe pas de maven-plugin pour gérer GitHub Markdown.
InformationsquelleAutor Paul Verest | 2013-02-12
  1. 63

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

    Ajouter à pom.xml

              <plugin>    
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-site-plugin</artifactId>
              <version>3.2</version>
              <dependencies>
                <dependency>
                  <groupId>org.apache.maven.doxia</groupId>
                  <artifactId>doxia-module-markdown</artifactId>
                  <version>1.3</version>
                </dependency>
              </dependencies>
            </plugin>

    Puis commencer à ajouter des pages en vertu de src/site/markdown/ avec .md extension.
    Pour chaque page ajouter un élément de menu comme dans sniplet ci-dessous: 

     <body>
    <!-- http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html 
    <item collapse=.. ref=.. name=.. href="README" img=.. position=.. alt=.. border=.. width=.. height=.. target=.. title=.. >
    -->
    <menu name="User guide">
      <item href="README.html" name="README" />
    </menu>

    <menu ref="reports" inherit="bottom" />
  </body>

    Que d'utiliser mvn site pour générer du site.
    Regardez target/site aux résultats de l'examen.

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

    Lire plus sur maven-site-plugin.

    Je recommande d'utiliser maven-fluido-peau. Il est plus récent de style, basé sur Twitter Bootstrap
    Ajoutez à cela site.xml

    <project name="xxx">
  [...]
  <skin>
    <groupId>org.apache.maven.skins</groupId>
    <artifactId>maven-fluido-skin</artifactId>
    <version>1.3.0</version>
  </skin>
  [...]
</project>

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

    • Ce post doit être ajouté à la Doxia de la documentation, car il n'est pas clair pour ceux d'entre nous qui n'ont pas utilisé de Maven pour gérer la documentation comment c'est fait. Merci.
    • Open-source exemple github.com/Nodeclipse/nodeclipse-1/tree/master/src/site
    • L'exécution de vivre dev.nodeclipse.com
    • Merci pour cette. J'ai été à la recherche pour les Démarques pour la génération de site à l'aide de Maven, et cela fonctionne parfaitement!
    • Posez la question sur stackoverflow.com 🙂 en utilisant les mêmes balises, et, éventuellement, référencement à cette question.
    • J'ai ajouté plusieurs de plus amples informations à mon projet: issueManagement, ciManagement, l'organisation, la scm et la description. Si ceux-ci sont ajoutés - la doxia-Plugin va pas me faire virer et markdown n'est pas compilé. Juste wantet pour ajouter cette - peut-être quelqu'un a le même message d'erreur(?).

    InformationsquelleAutor Paul Verest
  2. 4

    Une autre norme est d'utiliser le Plugin Maven Site comme suit

    Avec cette approche, vous pouvez profiter de la vitesse de moteur de template de filtrage. Donc, il ajoute plus de puissance à votre documentation.

    InformationsquelleAutor EliuX