获取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