48 votes

Paul Verest avatar

Comment utiliser le démarquage pour le site de projet maven?

Demandé el 12 de Février, 2013
Quand la question a-t-elle été
3719 affichage
Nombre de visites la question a
1 Réponses
Nombre de réponses aux questions
Résolu
Situation réelle de la question

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 qu'il 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é.

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

Demandé el 12 de Février, 2013 par Paul Verest

Réponse

Trop de publicités?

69voto

Paul Verest avatar
Paul Verest Points 3798

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

Ajoutez à cela 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 l' src/site/markdown/ avec .mdextension. 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 pour les 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

Répondu el 12 de Février, 2013 par Paul Verest (3798 Points )

Questions en vedette

Top Tags

Dans notre réseau

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

Yandex
X