问题标签 [doxia]

我正在使用 APT 格式在 Maven 项目中创建文档。我正在尝试链接到一个 JavaDoc 方法描述，该 URL 包含一个括号。

例如，网址

变成

尝试使用 URL 编码会产生类似的结果，即去掉百分比符号。

在这两种情况下，用反斜杠转义字符都没有效果。

有谁知道如何通过 apt 正确解释括号（或百分比）？

作为我们应用程序开发的一部分，我们正在使用 Maven 站点插件创建文档。我们的 apt 文件位于src/site/apt. 我知道可以使用 {{xxx}} 语法在 apt 中创建链接，但我想知道是否有一种简单的方法可以创建指向 java 文件和/或包的链接？

是使用相对路径的唯一方法（即：../../main/java/com/pkg/MyFile.java）吗？

有没有办法链接到包名？

当我使用 (doxia-module-markdown)[http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-markdown] 创建一个 maven 站点并且 .md 文件具有与 & 符号的链接时在错误消息中。示例.md：

错误信息： [ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.3:site (default-site) on project test: Error during page generation: Error parsing 'xxx\projects\test\src\site\markdown\not_working.md': line [3] Error parsing the model: entity reference name can not contain character =' (position: TEXT seen ...<a href="https://www.google.com/?gws_rd=cr&q=... @3:57) -> [Help 1]

一旦我删除＆符号，错误就会消失。

我正在生成一个项目站点

Linkcheck 被激活为报告插件

代码是在 Java 中的。

类文件的注释头包含指向 StackOverflow 问题的链接，例如

在站点生成的链接检查阶段，我收到如下警告：

我已经查看了有关“Cookie 被拒绝：非法域属性”的其他一些 SO 问题。根据这个 aswer，问题不在于我，而是 StackOverflow 和 GitHub 设置了一个不允许发送的 cookie，而底层的 http 库maven-linkcheck-plugin告诉我这一点。此行为完全符合RFC 2109的规定。

链接的问题提供了一种解决方法：设置一个 cookie 策略httpclient，基本上说，我不在乎坏 cookie，给我给我给我。我需要容忍不兼容的服务器，因此我需要使用cookie 指南中描述的浏览器兼容性 cookie 规范。

我的问题是：因为我不是在工作，httpclient而是在工作，我应该maven在我的文件中添加什么pom.xml来摆脱这些 cookie 警告？我没有发现任何有用的东西

• maven-linkcheck-插件文档
• Doxia LinkCheck 文档（Maven 插件使用 Doxia）
• 这个 Doxia JIRA 查询作为背景信息读起来很有趣，但仍然没有 Maven 解决方案

我的目标是生成也可以从 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 链接。

pom.xml

站点.xml

a.md

b.md

我正在使用 Doxia 插件进行降价，我想在其中添加图片

然后添加资源：

然后在我的章节中我写道：

但是什么都没有发生？此图片位于目标路径中。如何在markdown中指定路径？

我正在尝试将 Fluido Skin 用于我的 Maven 站点，但出现错误：

我的site.xml包含皮肤

我的 pom 包含：

在maven-fluido-skin版本中1.6一切正常。

我不知道我需要在哪里/如何升级 doxia。有人可以指导我吗？

我在我的 Maven 项目中尝试了以下方法：

• content.md添加带有内容的降价文件

在src/main/site/markdown.

• 写一个site.xml有内容的

  /li>

• 写pom.xml一个

  /li>

现在我content.html从mvn site. 在此文件中，不是int a = 4语法突出显示。

我需要做什么才能获得语法突出显示？

我正在创建一个 Maven 皮肤（请参阅https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/）。

如果链接是正在呈现的当前文件，我的site.vm需要在导航栏中突出显示链接。

因此，我需要知道site.vm正在呈现的 HTML 文件的名称。

$currentFileName和$alignedFileName宏适用于常规文档（例如来自 Markdown 源）。但是对于多页文档，例如 Maven 报告插件会生成，这些宏会不断返回报告主页的名称，而不是正在呈现的页面。

如何检索正在呈现的文件的实际名称，而不仅仅是 Maven 报告插件的主 HTML 页面的名称？

我尝试了以下宏但没有成功：

• $alignedFileName
• $currentFileName
• $docRenderingContext.getInputName()
• $docRenderingContext.getOutputName()

它们都返回相同的值，即 Maven 报告插件主页的 HTML 文件名。

KmReference.java（Maven Report 插件，使用getSinkFactory().createSink(outputDirectory, pageFilename)创建多个页面）：

site.vm（速度）：

在我的 Maven Report 插件生成的所有 HTML 文件中，我将得到完全相同的值：

another-page.html（不是 km-reference.html）：

我希望至少$alignedFileName返回值another-page.html。

我们在Maven 生成的站点中使用 Markdown 。奇迹般有效。AFAIK 该插件在后台使用Flexmark，它支持Admonition 扩展。

我们也想使用它们，信息框对文档很有帮助。我们的站点配置pom.xml如下所示：

我们如何配置它来识别额外的降价？