如何对maven项目站点使用markdown

如何使用maven和markdown标记语言开始项目文档？Maven站点默认为APT，这对于只学习Maven的方式是不舒服的。（通常，团队中没有人会开始编写maven站点文档，而此时他们还需要学习另一种标记语言。）

有人尝试过在Maven项目站点文档中使用markdown（与github上使用的标记语言相同）吗？我从Maven Doxia的参考资料中看到，这是可能的。有什么问题吗？

我是maven网站生成的新手。我认为markdown比团队没有使用过的其他标记语言更好。

更新。成功。请参阅下面的答案。

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

然后开始在扩展名为.md的src/site/markdown/下添加页面。对于每个页面添加菜单项，如下面的小片段：

 <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:TEMPfullsite在一个文件夹中获取多模块化项目站点。

阅读更多关于maven站点插件的信息。

我建议使用maven fluido皮肤。这是基于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

另一种标准方法是使用Maven站点插件，如下

https://maven.apache.org/plugins/maven-site-plugin/
https://illegalexception.schlichtherle.de/maven/2013/06/17/how-to-use-markdown-syntax-with-the-maven-site-plugin/

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

相关内容

最新更新

热门标签：