web-dev-qa-db-fra.com

Comment utiliser le démarque pour le site du projet Maven?

Comment commencer avec la documentation du projet en utilisant le langage de balisage maven et markdown? La valeur par défaut du site Maven est APT, ce qui est inconfortable d'apprendre juste à faire les choses de manière maven. (Habituellement, personne dans une équipe ne commencera à écrire la documentation du site maven alors qu'il doit é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 du projet Maven? Je vois de références Maven Doxia que c'est possible. Quelque problème que ce soit?

Je suis nouveau dans la génération de sites maven. Je pense que le démarquage est préférable pour commencer, que d'autres langages de marquage, avec lesquels l'équipe n'a pas travaillé.

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

mavenmarkdownmaven-site-plugin
45
Paul Verest

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

Ajoutez ceci à 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>

Ensuite, commencez à ajouter des pages sous src/site/markdown/ avec .md extension. Pour chaque page, ajoutez un élément de menu comme dans le 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 le site. Regarder target/site pour examiner les résultats.

mvn site:stage -DstagingDirectory=C:\TEMP\fullsite pour obtenir le site du 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 Ajoutez ceci à 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

63
Paul Verest

Un autre moyen standard consiste à utiliser le Maven Site Plugin comme suit

Avec cette approche, vous pouvez profiter du filtrage du moteur de modèle de vitesse. Cela ajoute donc plus de puissance à votre documentation.

4
EliuX