47

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

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

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

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

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

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

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

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

于 2015-02-04T23:53:01.707 回答