如何将github markdown文件包含到maven站点中

Question

Github建议在项目的根目录中创建Markdown格式的文件，如README.md，LICENCE.md或CONTRIBUTORS.md。另一方面，这些文件对于自动生成的maven站点来说将是有价值的内容。

将这些文件包含在生成的网站报告中的最佳做法是什么？

我有一个想法是将它们复制到src / site / markdown并在成功生成网站后再次删除它们（以避免SCM污染）。

Answer 1

我使用您在问题中概述的方法解决了Git存储库中文件README.md的问题，即将README.md从根目录复制到${baseDir}/src/site/markdown。我使用maven-resources-plugin来复制文件。我不是在生成网站后删除复制的文件（为了避免SCM污染），而是将其作为Bruno suggested添加到.gitignore。

该解决方案的详细说明如下。

project.build.plugins的{​​{1}}部分：

pom.xml

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

您可以看到相应的提交here。

Answer 2

贡献者应该被放入pom。许可证文件应该是项目的一部分，通常是LICENSE.txt，作为Apache建议的pom.xml文件的兄弟。 README.txt也是Apache建议的。 README.md通常仅对GitHub在显示存储库期间呈现它有价值。