Jak korzystać z markdown na stronie projektu maven?

Jak zacząć od dokumentacji projektowej za pomocą Maven i markdown Markup language? Domyślną stroną Maven jest APT, co jest niewygodne, aby nauczyć się robić rzeczy maven sposób. (Zazwyczaj nikt w zespole nie zacznie pisać dokumentacji witryny maven, gdy po drodze będzie musiał nauczyć się jeszcze jednego języka znaczników.)

Czy ktoś próbował użyć markdown (tego samego języka znaczników, który jest używany na GitHubie)do dokumentacji Strony Projektu Maven? Widzę z Maven doxia referuje że to jest możliwe. Jakieś problemy?

Jestem nowy w maven site generation. Myślę, że od markdown lepiej zacząć, niż od innych języków znaczników, z którymi zespół nie współpracował.

UPDATE. Udało się. Zobacz odpowiedź poniżej.

Author: Paul Verest, 2013-02-12
Source

2 answers

Cytat z http://maven.apache.org/doxia/references/index.html

Dodaj to do 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>

Następnie zacznij dodawać strony pod src/site/markdown/ z rozszerzeniem .md. Dla każdej strony Dodaj pozycję menu jak w wycinku poniżej: 

 <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>

Niż użyć mvn site do wygenerowania strony. Spójrz na target/site, aby przejrzeć wyniki.

mvn site:stage -DstagingDirectory=C:\TEMP\fullsite aby uzyskać wielomodułową stronę projektu w jednym folderze.

Przeczytaj więcej o maven-site-plugin.

Polecam do użycia maven-fluido-skin. Jest to najnowszy styl, oparty na Twitter Bootstrap Dodaj to do strony.xml 

<project name="xxx">
  [...]
  <skin>
    <groupId>org.apache.maven.skins</groupId>
    <artifactId>maven-fluido-skin</artifactId>
    <version>1.3.0</version>
  </skin>
  [...]
</project>
[[9]}Zobacz https://github.com/winterstein/Eclipse-Markdown-Editor-Plugin
 62
Author: Paul Verest,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2013-10-21 09:13:00

Innym standardowym sposobem jest użycie Maven Site Plugin w następujący sposób

Dzięki temu podejściu można skorzystać z filtrowania silnika szablonu prędkości. To dodaje więcej mocy do Twojej dokumentacji.

 3
Author: EliuX,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2017-05-30 00:58:32