獲取doxia-module-markdown以重寫* .md鏈接

Question

我的目標是生成可以從github中瀏覽的站點文檔，所以我寫了一堆降價頁面。

我正在使用帶有doxia-module-markdown maven-site-plugin來生成項目文檔。

我[foo](foo.md)的問題是[foo](foo.md)形式的鏈接在生成的HTML中顯示為<a href="foo.md">foo</a> ，而不是<a href="foo.html">foo</a> 。

將鏈接更改為指向foo.html會使Github無法顯示，並且在我看來.md → .html映射是HTML生成工作方式的組成部分，因此鏈接重寫應該在這里發生。

下面是repro的最小案例，它為我生成以下輸出

我是否缺少一些配置選項以獲取相對鏈接重寫以將源文件路徑應用於目標文件路徑轉換？

翻譯的HTML包含.md鏈接。

$ mvn clean site && cat target/site/a.html | grep -i banana
...
<p>&#x2018;A&#x2019; is for apple, <a href="b.md">&#x2018;b&#x2019;</a> is for banana.</p>

的pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>foo</groupId>
  <artifactId>bar</artifactId>
  <packaging>jar</packaging>
  <version>1-SNAPSHOT</version>

  <name>Foo</name>
  <description>
  Tests link rewriting using the doxia markdown module.
  </description>
  <url>https://example.com/</url>  <!-- should not affect relative URLs -->

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.5</version>
        <dependencies>
          <dependency>
            <groupId>org.apache.maven.doxia</groupId>
            <artifactId>doxia-module-markdown</artifactId>
            <version>1.7</version>
          </dependency>
        </dependencies>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>2.8.1</version>
      </plugin>
    </plugins>
  </build>
</project>

的site.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<project>
  <skin>
    <groupId>org.apache.maven.skins</groupId>
    <artifactId>maven-fluido-skin</artifactId>
    <version>1.5</version>
  </skin>

  <body>
    <links>
    </links>

    <menu name="docs">
      <item name="a" href="a.html"/>
      <item name="b" href="b.html"/>
    </menu>

    <menu ref="reports"/>

    <menu ref="modules"/>

    <menu ref="parent"/>
  </body>
</project>

a.md

# A

'A' is for apple, ['b'](b.md) is for banana.

b.md

# B

['A'](a.md) is for apple, 'b' is for banana.

Answer 1

markdown-page-generator-plugin提供了transformRelativeMarkdownLinks選項，如果選項為true，它將相對url后綴從“.md”轉換為“.html”。 （默認值：false。）

建立：

將doxia-module-markdown文件放在/src/site/markdown/ doxia-module-markdown中
將markdown文件放入markdown markdown-page-generator-plugin不同名稱的文件夾，例如/src/site/markdown_/
將doxia-module-markdown添加的html代碼放入header.html和footer.html
配置markdown-page-generator-plugin以包含header.html和footer.html
配置markdown-page-generator-plugin將處理后的文件添加到doxia-module-markdown使用的同一目標文件夾中

適應`pom.xml` ：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-site-plugin</artifactId>
  <version>3.6</version>
  <dependencies>
    <!-- processes ${project.basedir}/src/site/markdown/ -->
    <dependency>
      <groupId>org.apache.maven.doxia</groupId>
      <artifactId>doxia-module-markdown</artifactId>
      <version>1.7</version>
    </dependency>
  </dependencies>
</plugin>
<plugin>
  <groupId>com.ruleoftech</groupId>
  <artifactId>markdown-page-generator-plugin</artifactId>
  <version>0.10</version>
  <executions>
    <execution>
      <phase>process-sources</phase>
      <goals>
        <goal>generate</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <inputDirectory>${project.basedir}/src/site/markdown_/</inputDirectory>
    <outputDirectory>${project.build.directory}/site/</outputDirectory>

    <!-- copy other /markdown_/* directories -->
    <copyDirectories>images_,quickstart_files</copyDirectories>

    <!-- put doxia-module-markdown additional html in these header & footer files -->
    <headerHtmlFile>${project.basedir}/src/site/markdown_/html/header.html</headerHtmlFile>
    <footerHtmlFile>${project.basedir}/src/site/markdown_/html/footer.html</footerHtmlFile>

    <!-- transform relative url suffix from ".md" to ".html" -->
    <transformRelativeMarkdownLinks>true</transformRelativeMarkdownLinks>

    <pegdownExtensions>ANCHORLINKS,HARDWRAPS,AUTOLINKS,TABLES,FENCED_CODE_BLOCKS</pegdownExtensions>
  </configuration>
</plugin>

更新：

Apache Maven Doxia Markdown模塊1.8更新為“將解析器從Pegdown切換到Flexmark” 。 因此，groupId com.ruleoftech中使用的markdown生成器，artifactId markdown-page-generator-plugin現在是Maven Doxia本身的一部分。

<dependency>
  <groupId>org.apache.maven.doxia</groupId>
  <artifactId>doxia-module-markdown</artifactId>
  <version>1.8</version>
</dependency>

警告：盡管Maven Doxia 1.8使用flex-markjava ，但不確定所有的flexmark-java功能是否都可以通過Doxia獲得。 如果Doxia沒有出現所需的flexmark-java功能，那么markdown-page-generator-plugin仍然是在Doxia上下文之外處理markdown內容的選項。

Answer 2

如果您在服務器上托管文件並且可以訪問網站目錄，則可以嘗試使用.htaccess文件，該文件應位於MD文件所在目錄的根目錄中。

在.htaccess ，添加以下內容：

RewriteEngine On
RewriteRule /(.*).md /$1.html

如果你知道一點Regex，你會注意到RewriteRule正在捕獲.md文件的名稱並將其轉換為.html 。 這適用於.md文件的所有請求，並且不會在GitHub或遠程服務器中編輯任何內容。 有關更多詳細信息，請查看此文章，了解如何使用.htaccess重寫URL

獲取doxia-module-markdown以重寫* .md鏈接

問題描述

的pom.xml

的site.xml

a.md

b.md

2 個解決方案

解決方案1
3 2017-01-22 06:53:06

建立：

適應`pom.xml` ：

更新：

解決方案2
0 2016-04-29 08:21:54

獲取doxia-module-markdown以重寫* .md鏈接

問題描述

的pom.xml

的site.xml

a.md

b.md

2 個解決方案

解決方案1 3 2017-01-22 06:53:06

建立：

適應pom.xml ：

更新：

解決方案2 0 2016-04-29 08:21:54

解決方案1
3 2017-01-22 06:53:06

適應`pom.xml` ：

解決方案2
0 2016-04-29 08:21:54