Question

我的目标是生成可以在github中浏览的站点文档，所以我写了一堆降价页面。

我正在使用maven-site-plugin和doxia-module-markdown来生成项目文档。

我遇到的问题是[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选项，该选项将转换来自＆＃34; .md＆＃34;的相对网址后缀。到＆＃34; .html＆＃34;如果选项为true。（默认值：false。）

设置：

将doxia-module-markdown /src/site/markdown/处理的降价文件放入markdown-page-generator-plugin
将/src/site/markdown_/处理的降价文件放入不同名称的文件夹，例如doxia-module-markdown
将header.html添加的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>  <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>  <copyDirectories>images_,quickstart_files</copyDirectories>  <headerHtmlFile>${project.basedir}/src/site/markdown_/html/header.html</headerHtmlFile> <footerHtmlFile>${project.basedir}/src/site/markdown_/html/footer.html</footerHtmlFile>  <transformRelativeMarkdownLinks>true</transformRelativeMarkdownLinks> <pegdownExtensions>ANCHORLINKS,HARDWRAPS,AUTOLINKS,TABLES,FENCED_CODE_BLOCKS</pegdownExtensions> </configuration> </plugin>：

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

更新

Apache Maven Doxia Markdown模块1.8已更新为"switch parser from Pegdown to Flexmark"。因此，groupId com.ruleoftech中使用的markdown生成器，artifactId markdown-page-generator-plugin现在是Maven Doxia本身的一部分。

flexmark-java

警告：虽然Maven Doxia 1.8使用flex-markjava，但不确定所有markdown-page-generator-plugin功能是否都可以通过Doxia获得。如果Doxia未显示所需的flexmark-java功能，则var link = "?add-to-cart=" + add_to_cart + "&variation_id=" + variation_id + "&attribute_pa_color=" + pa_color;仍可用于处理Doxia环境之外的降价内容。

Answer 2

如果您在服务器上托管文件并且可以访问您的网站目录，则可以尝试使用应该位于MD文件所在目录根目录的.htaccess文件。

在.htaccess中，添加以下内容：

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

如果您了解一点Regex，您会注意到RewriteRule正在捕获.md文件的名称并将其转换为.html。这适用于.md文件的所有请求，并且不会在GitHub或远程服务器中编辑任何内容。有关详情，请查看this post，了解如何使用.htaccess

重写网址

获取doxia-module-markdown以重写* .md链接

的pom.xml

的site.xml

a.md

b.md

2 个答案:

设置：

更新