3

我的目标是生成也可以从 github 中浏览的站点文档，因此我编写了一堆降价页面。

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

我遇到的问题是表单的链接[foo](foo.md)在生成的 HTML 中显示为<a href="foo.md">foo</a>，而不是<a href="foo.html">foo</a>.

将链接更改为指向foo.html会使事情无法从 Github 浏览，在我看来.md→.html映射对于 HTML 生成的工作方式是不可或缺的，因此应该在此处进行链接重写。

以下是重现的最小案例，它为我产生以下输出

我是否缺少一些配置选项来获得相对链接重写以将源文件路径也应用于目标文件路径转换？

翻译后的 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>

站点.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.
4

2 回答 2

3

markdown-page-generator-plugin提供一个transformRelativeMarkdownLinks选项，如果选项为真，则将相对 url 后缀从“.md”转换为“.html”。（默认值：假。）

设置：

  • 将要处理的markdown文件放入doxia-module-markdownin/src/site/markdown/
  • 将要处理的降价文件放在markdown-page-generator-plugin不同命名的文件夹中，例如/src/site/markdown_/
  • 将添加的html代码doxia-module-markdown放入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 获得。markdown-page-generator-plugin如果 Doxia 没有提供所需的flexmark-java功能，它仍然是在 Doxia 上下文之外处理降价内容的一个选项。

于 2017-01-22T06:53:06.943 回答
0

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

在.htaccess中，添加：

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

如果您了解一点正则表达式，您会注意到它RewriteRule正在捕获.md文件的名称并将其转换为.html. 这适用于所有文件请求.md，并且不会编辑 GitHub 或远程服务器中的任何内容。有关更多详细信息，请查看这篇关于如何使用重写 URL的帖子.htaccess

于 2016-04-29T08:21:54.390 回答