问题标签 [antora]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
162 浏览

asciidoc - 如何在 AsciiDoc 中为图形添加空白标题

我有一个包含许多图像的 AsciiDoc 页面。我正在通过安托拉将其转换为 html。

在我的 AsciiDoc 页面上,有些图片有标题,有些没有。

对于带有标题的图像,第一个命名为“图 1. 一些有趣的标题”,然后第二个命名为“图 2. 一些有趣的标题”,依此类推。实际上,“图1”、“图2”文字是Antora自动添加的。在 AsciiDoc 本身中,标记如下:

但是,现在我有第三张图像,它没有要显示的标题。我希望这张图片可以简单地阅读“图 3”。但是,我不知道该怎么做。我唯一能想到的就是在“。”之后加上一些字符。就在它上面的符号(我选择了一个分号),如下:

这会产生“图 3;” 一旦转换成html。

总比没有好,但我希望能够使用例如空白字符而不是分号,这样我就可以简单地生成显示为“图 3”的文本(使用没有人的不可见空白字符可以看到)。不幸的是,如果我尝试这样做,空格将被忽略,我只会看到“。” 生成的html中的字符。

0 投票
1 回答
112 浏览

asciidoc - 如何在 Asciidoc 中为表头、行和单元格元素添加特定的 css 属性

可以将特定的类添加到 asciidoc 中的表中,如下所示:

ASCIIDOC

HTML(在 Antora 运行之后)

因此,“自定义”的“角色”已应用于 <table> 元素。但是,我还想为 <th>、<tr> 和 <td> 元素指定特定属性。我该怎么做呢 ?

我尝试过:

对于第一个元素,并且:

对于 td 元素

但这只会在转换为 html 时给我以下信息:

我如何实现以下目标:

0 投票
1 回答
29 浏览

unit-testing - 在 unittest 中检查文件系统结构(文件夹名、文件名)

我正在寻找一种将单元测试添加到我的文档的方法。我使用 antora 从 asciidoc 生成我的文档网站。工作得很好。现在我正在寻找一种方法来对我的文档(asciidoc 文件)进行单元测试。但这不是我现在的问题。

我现在想要的是一种测试我的文档的文件系统结构的方法。我有几个具有类似基本设置和基本文档的存储库。细节有所不同,但例如我想确保每个文档在 PROJECT/docs/modules/ROOT 中都有它们的主要文档,并且导航文件在每个模块等中都命名为 nav.adoc。

基本上我希望每个项目都使用相同的文档结构。

所以我想知道是否有办法测试文件系统(文件夹名,文件名)。最终,这些测试应该是我的 gitlab ci 管道的一部分。

archunit 可以帮忙吗?如果没有更好的方法,我会考虑,但由于 archunit 以 java 项目为目标,所以对于我的 uaecase 来说似乎有点过分了。

0 投票
1 回答
214 浏览

html - 仅使用css将文本悬停时如何使标签弹出

我在页面左侧有一个链接列表。我想改进此列表,以便当我将光标放在此列表中的某个项目上时,会出现某种标签,该标签会简要说明链接指向的内容。有问题的 html 是使用来自 AsciiDoc 源的 Antora 自动生成的,据我所知,我所能做的就是为链接文本的不同部分添加一个 css 类或 id,这些部分以粗体显示。我无法添加任何 Javascript 或嵌套的 css 类。

所以这是我的尝试:

这显然没有达到我想要的效果。它所做的只是有一个小字体的文本,当我翻过它时,它会在一种盒子里变成一个更大的字体。

如果有人能想出某种方式在页面中的某个链接上弹出标签,即使使用一些我没有想到的完全不同的方法,我将不胜感激。请注意,我将有大约 200 个链接,所以如果我可以有一个解决方案,不需要我为每个链接的每个不同的 id 拥有一组 css 属性,那将是可取的。

如果这个问题有任何不清楚的,请随时问我。

0 投票
1 回答
44 浏览

asciidoc - pages文件夹中的.adoc文件旁边是否可以有图像?

如文档中所述,家庭目录的结构要求将每个图像都放在images目录中。但是,OptaPlanner 文档在每章的同一目录中包含图像和 asciidoc 文件。请看下面的目录结构:

https://github.com/kiegroup/optaplanner/tree/main/optaplanner-docs/src/main/asciidoc

由于来自外部存储库的现有引用(破坏了向后兼容性),因此不希望更改当前结构。

有没有办法配置 Antora 从pages目录及其子目录中获取图像?

0 投票
0 回答
43 浏览

asciidoc - 具有多个源存储库时,Antora playbook 执行崩溃

我从现在开始使用 Antora 2.3,随着文档站点的增长,我不得不在我的 playbook.yaml 文件中引入更多的源代码库。

目前,我有 50-60 个 Git 存储库,每个大小约为 15 MB,在剧本中提到。之后,我的站点生成开始崩溃,同时并行克隆我content.sources[]的 playbook.yaml 中提到的存储库(即从 Linux shell 中的 Antora 命令退出而没有任何错误)。

我尝试分配更多内存并收到相同的上述问题

0 投票
1 回答
99 浏览

javascript - 如何在 Antora 中包含自定义 CSS、HTML 和 Javascript?

在 Antora 生成的站点中包含您自己的 HTML、CSS 和 Javascript 页面是否有“本机”方式?

在 Asciidoc 源代码中包含一个带有内联 CSS 样式的 HTML 文件仅适用于这样的 HTML 和 CSS(结果请参见附图):

但是,如果您要分离 CSS 并添加 Javascript,则 .css 和 .js 文件不会被发布,因为它们没有直接包含在任何地方,并且包含的​​ HTML 遵循 UI 包定义的样式。

手动将 CSS 和 Javascript 文件复制到构建文件中的正确位置可以按预期工作(Antora 页面已设置样式并按预期运行 .js)

我认为大多数 Antora 文档都是一些 CI/CD 管道的产品,因此您可能可以将 CSS 和 Javascript 作为管道的一部分添加到构建文件中,但这是一个混乱的解决方案。

真正需要的是一种强制 Antora 发布一些“额外”文件或文件夹的方法。

我知道 Antora 的全部意义在于制作一致的样式和格式的文档。想要这样做的原因是在文档中包含由 Plotly 或 Bokeh 生成的交互式图表。

它还开辟了包括任何类型的交互式窗口的可能性,例如播放音乐的按钮。就我而言,我想要一个“交互式和弦书”,可以播放和突出音乐和弦中的音符。

Antora 网站上的内联样式