如何將github markdown文件包含到maven站點

Github建議在項目的根目錄中創建Markdown格式的文件，如README.md，LICENCE.md或CONTRIBUTORS.md。另一方面，這些文件對於自動生成的Maven站點而言將是非常有價值的內容。如何將github markdown文件包含到maven站點

將這些文件包含到生成的網站報告中的最佳做法是什麼？

我的一個想法是將它們複製到src/site/markdown中，並在成功生成站點後再次移除它們（以避免SCM污染）。

來源

2012-12-06 Hakan

如果您使用的是git，您可以將複製的文件添加到.gitignore中，以防止將這些文件添加到源代碼樹中。我想其他VCS有類似的機制。 –

貢獻者應該被放入pom。許可證文件應該是項目的一部分，通常是LICENSE.txt作爲Apache建議的pom.xml文件的兄弟。 README.txt也由Apache提供。 README.md通常只對GitHub在存儲庫的顯示過程中呈現這個有價值。

來源

2012-12-06 17:25:17 khmarbaise

我知道maven約定。我只是想避免保留相關信息的雙份，堅持幹（不重複）原則。 – Hakan

我使用您在問題中列出的方法，即將根目錄中的README.md複製到${baseDir}/src/site/markdown，解決了Git存儲庫中文件README.md的此問題。我用maven-resources-plugin複製文件。在生成站點之後（以避免SCM污染），我沒有刪除複製的文件，而是將它作爲Bruno suggested添加到.gitignore。

解決方案的詳細說明如下。

在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

你可以看到相應的承諾here。

來源

2016-02-16 10:20:04

如何將github markdown文件包含到maven站點

回答

相關問題