如何使用markdown为maven项目网站?
如何使用Maven和Markdown标记语言开始项目文档? Maven的网站默认是APT,学习只是做事情的方式是不舒服的。 (通常,一个团队中的任何人都不会开始编写maven站点文档,因为他们还需要学习另外一种标记语言。)
有没有人试图使用markdown(与github上使用的相同的标记语言)的Maven项目网站文档? 我从Maven Doxia参考中看到,这是可能的。 任何问题?
我是新的maven网站一代。 我认为降价比其他的标记语言更好,因为这个团队还没有合作过。
UPDATE。 成功了。 见下面的答案。
从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
扩展名的页面。 为每个页面添加菜单项如下面的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>
比使用mvn site
生成网站。 查看target/site
以查看结果。
mvn site:stage -DstagingDirectory=C:\TEMP\fullsite
以在一个文件夹中获取多模块项目站点。
阅读更多关于maven-site-plugin的信息 。
我build议使用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
另一个标准的方法是使用Maven站点插件如下
- http://maven.apache.org/plugins/maven-site-plugin/
- http://illegalexception.schlichtherle.de/2013/06/17/how-to-use-markdown-syntax-with-the-maven-site-plugin/
采用这种方法,您可以利用速度模板引擎过滤。 所以它为您的文档增加了更多的权力。