47

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

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

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

アップデート。成功しました。以下の回答を参照してください。

4

2 に答える 2

67

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も参照して ください。

于 2013-02-12T11:25:01.280 に答える
5

もう 1 つの標準的な方法は、次のようにMaven サイト プラグインを使用することです。

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

于 2015-02-04T23:53:01.707 に答える