如何将github markdown文件包含到maven站点中
Github建议在项目的根目录中创建Markdown格式的文件，如README.md，LICENCE.md或CONTRIBUTORS.md。 另一方面，这些文件对于自动生成的Maven站点而言将是非常有价值的内容。
将这些文件包含到生成的网站报告中的最佳做法是什么？
我的一个想法是将它们复制到src / site / markdown中，并在成功生成站点后再次移除它们（以避免SCM污染）。
我使用您在问题中概述的方法解决了Git存储库中文件README.md这个问题， README.md根目录中的README.md复制到${baseDir}/src/site/markdown 。 我使用maven-resources-plugin来复制文件。 在生成站点之后（以避免SCM污染），我没有删除复制的文件，而是将它添加到.gitignore正如Bruno所建议的。
解决方案的详细描述如下。
在pom.xml project.build.plugins部分中：
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<!-- Copy the readme file to the site source files so that a page is generated from it. -->
<id>copy-readme</id>
<phase>pre-site</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${basedir}/src/site/markdown</outputDirectory>
<resources>
<resource>
<directory>${basedir}</directory>
<includes>
<include>README.md</include>
</includes>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
在.gitignore ：
# Copied from root to site source files by maven-resources-plugin
/src/site/markdown/README.md
你可以在这里看到相应的提交。
贡献者应该被放入pom中。 许可证文件应该是项目的一部分，通常是LICENSE.txt作为Apache建议的pom.xml文件的兄弟。 README.txt也由Apache提供。 README.md通常只对GitHub在存储库的显示过程中呈现这个有价值。
链接地址: http://www.djcxy.com/p/11541.html