web-dev-qa-db-ja.com

mavenプロジェクトサイトでmarkdownを使用する方法

Mavenとmarkdownマークアップ言語を使用してプロジェクトのドキュメントから始める方法は？ MavenサイトのデフォルトはAPTです。これは、Mavenのやり方で学ぶだけでは不快です。 （通常、チームの誰もが途中でもう1つのマークアップ言語を学ぶ必要があるときに、Mavenサイトのドキュメントを書き始めることはありません。）

Mavenプロジェクトサイトのドキュメントにマークダウン（githubで使用されているものと同じマークアップ言語）を使用しようとした人はいますか？ Maven Doxiaの参照 からそれが可能であることがわかります。問題はありますか？

Mavenサイト生成は初めてです。マークダウンは、他のマークアップ言語よりも、チームで作業していないものから始める方がよいと思います。

更新。成功しました。以下の回答を参照してください。

mavenmarkdownmaven-site-plugin
45
Paul Verest

http://maven.Apache.org/doxia/references/index.html からの引用

これを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>

次に、src/site/markdown/拡張子の付いた.mdの下にページを追加します。すべてのページについて、以下のスニペットのようなメニュー項目を追加します。

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

mvn siteを使用してサイトを生成するよりも。結果を確認するには、target/siteをご覧ください。

mvn site:stage -DstagingDirectory=C:\TEMP\fullsiteを使用すると、マルチモジュラープロジェクトサイトを1つのフォルダーで取得できます。

maven-site-plugin の詳細をご覧ください。

maven-fluido-skin を使用することをお勧めします。 Twitterに基づく最新のスタイルですBootstrapこれをsite.xmlに追加してください

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

参照 https://github.com/winterstein/Eclipse-Markdown-Editor-Plugin

63
Paul Verest

別の標準的な方法は、次のようにMaven Site Pluginを使用することです

このアプローチでは、速度テンプレートエンジンのフィルタリングを利用できます。したがって、ドキュメントにより多くの力を追加します。

4
EliuX