如何在maven项目网站上使用markdown？

Question

如何在maven项目网站上使用markdown？

Pau*_*est 45 markdown maven maven-site-plugin

如何使用maven和markdown标记语言开始项目文档？Maven站点默认是APT,这对于学习maven方式来说是不舒服的.(通常团队中的任何人都不会开始编写maven站点文档,因为他们还需要在此过程中学习一种标记语言.)

有没有人试图使用markdown(与github上使用的标记语言相同)来获取Maven项目站点文档？我从Maven Doxia的文章中看到它是可能的.有什么问题？

我是maven网站一代的新手.我认为markdown最好先于其他标记语言开始,团队还没有合作过.

UPDATE.成功了.见下面的答案.

Answer 1

Pau*_*est 63

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

Run Code Online (Sandbox Code Playgroud)

然后开始下添加页面src/site/markdown/与.md扩展.对于每个页面添加菜单项,如下面的sniplet:

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

Run Code Online (Sandbox Code Playgroud)

比使用mvn site生成网站.查看target/site结果.

mvn site:stage -DstagingDirectory=C:\TEMP\fullsite 在一个文件夹中获取多模块化项目站点.

阅读有关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>

Run Code Online (Sandbox Code Playgroud)

另请参见 https://github.com/winterstein/Eclipse-Markdown-Editor-Plugin

这篇文章需要添加到Doxia文档中,因为对于我们这些尚未使用Maven来管理文档如何完成的人来说,这一点并不清楚.谢谢. (5认同)
开源示例https://github.com/Nodeclipse/nodeclipse-1/tree/master/src/site (2认同)

Answer 2

Eli*_*iuX 5

另一种标准方法是使用Maven Site Plugin，如下所示

通过这种方法，您可以利用速度模板引擎过滤。因此，它为您的文档增加了更多功能。

这种方法利用了站点插件所做的速度模板引擎过滤 http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html#Filtering 显然，你的降价可以参考 maven像 ${project.name} 这样的变量 (2认同)

归档时间：	12 年，10 月前
查看次数：	12487 次
最近记录：	8 年，6 月前