问题标签 [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.
documentation-generation - Antora 顶部导航栏定制
我的问题很简单,尽管我在文档中找不到任何指向它的东西。
我正在使用 Antora 中的默认生成器为项目生成文档,但我无法弄清楚如何自定义顶部导航栏,右侧的项目,它们有一些默认值。
由于网站已生成,我应该在哪里更改或如何更改这些项目?我不想在那里列出这些项目。
antora - 错误:无法读取隐式映射对;第 8 行第 65 列遗漏了一个冒号:"
使用 powershell 在 Antora 上的 yml 文件,所以我收到此错误,请帮我解决它。“错误:无法读取隐式映射对;第 8 行第 65 列缺少冒号:”
我尝试将冒号添加到第 8 行
我期待编译应该开始并生成网站
google-cloud-platform - 从 Antora 连接到 Google Cloud Source Repository
我正在使用Antora为我们的文档生成一个静态站点。我已按照他们的指导进行私有存储库身份验证,但没有成功。似乎他们只支持基于 HTTPS 的 GIT 的 HTTPS Basic Auth。我尝试生成和使用Application Specific Password、GIT Cookie、OAuth 令牌都没有成功。您对如何提供身份验证有任何指导吗?
attributes - Asciidoctor:激活 CLI 属性中的替换
内联宏pass
似乎不适用于 CLI 属性。
如果我呈现以下代码段:
我得到了我的期望:你好疯狂的世界
但是如果我将这两个属性传递给 CLI ( asciidoctor-pdf -a foo=crazy -a bar='pass:q,a[{foo} *world*]' foo.adoc
),它就不起作用:
你好 pass:q,a[{foo} *world*]
我该怎么做才能让它发挥作用?
为了添加一点上下文,我计划使用 anora 来编写我正在开发的软件的文档。我想在antora-playbook.yml
或中定义属性antora.yml
以充当“乳胶宏”。
asciidoctor - 生成的 PDF 文档中没有图像(从 Asciidoc 到 PDF)
我正在使用 asciidoctor-web-pdf 从 asciidoc 生成 PDF 文档。到目前为止,大多数任务都可以正常工作。
但我的文档不包含图像或生成的图表(植物)。
文件夹结构遵循 Antora 的布局,因为我主要使用 Antora。PDF 只是一个必要的副产品。
我的文件夹结构如下所示(如 antora-layout 所述):
pdf.adoc 只是一个包含列表,以确保每个需要的 adoc 文件都是 PDF 的一部分。
根据文件夹结构,我的 logo.png 的正确路径是docs/modules/ROOT/assets/images/logo.png
(或绝对路径/home/sebastian/work/workspace/workspace-p/jira-ops-manual/docs/modules/ROOT/assets/images/logo.png
)。
当我使用上述命令生成 PDf 时,出现以下错误:
- 正常图像
- 植物图
我想问题是 asciidoctor-web-pdf 没有替换image$...
路径的一部分,所以引用是错误的(或者通常无法解决这些引用)。图像和图表嵌入如下:
有没有人提示如何解决我的问题?我也对其他解决方案持开放态度。也许安托拉有一种更简单的方法,所以我根本不需要 asciidoctor-web-pdf?
编辑:我通过在 pdf-adoc 顶部设置图像路径解决了普通图像的问题。
:imagesdir: ./assets/images
vega-lite - 在 Antora 中嵌入 Vega-Lite 图表
我正在尝试将这个 vega-lite 图嵌入到我的 antora 文档中:https ://vega.github.io/vega-lite/examples/line_overlay.html
我的 Asciidoc 文件如下所示:
问题是找不到包含我的数据的 CSV 文件。我尝试了我想象的每条路径......相对和绝对文件系统路径以及相对和绝对 http url。我仍然总是收到这条消息:
Skipping vegalite block
不应该出现。
我用直接在 json 块中定义的数据尝试了 vega-lite。这个片段有效。所以 Vega-Lite 在一般工作中(我使用 Kroki 服务器来生成图表)。
直接在图表定义中定义我的数据对我来说不是一个解决方案。现在我只是想用 demo-CSV 文件让它工作。但之后我将切换到我自己的自动生成的大型 CSV 文件。我的真实 CSV 和演示文件都位于docs/modules/technical-docs/assets/attachments/monitoring-logging-reporting/stocks.csv
.
我的一般设置包括几个项目。
- 包含 antora 剧本和 shell 脚本的项目,用于在我的本地主机上生成我的文档
- 包含 Asciidoc、CSV 文件和一堆其他文档和源代码的项目
- 其他几个包含与手头问题无关的 asciidoc 文档的项目。
有人有想法吗?谢谢你的帮助。
css - Antora 补充 ui 从 doc.css 中的 doc 中删除 max-width
我正在使用 anora 来记录产品架构规范。我们有大图,因此在最大化浏览器窗口时允许 svg 图像尽可能放大是一大优势。
我什至不是 CSS 新手。我几乎一无所知。我可以构建 antora 文档(网页),所以从用户的角度来看,我只知道一点点 antora。
我发现了这个关于如何使缩放起作用的评论。https://gitter.im/antora/users?at=5d97c8ea37073b36a06fddb8
如果我编辑 doc.css,构建一个 ui-bundle.zip,将 local-antora-playbook.yml 指向新创建的 ui-bundle.zip 并重建站点,我可以获得所需的结果。
这是我在上面找到并发布的评论链接中的建议编辑。我更喜欢使用这里引用的补充 UI 方法;Antora 顶部导航栏自定义和实际使用的文档为 antora https://gitlab.com/antora/docs.antora.org。
当我通过补充 ui 方法构建时,我可以看到我编辑的 doc.css 是在新站点中创建的。但是,我没有得到想要的结果,即在最大化时能够使用网络浏览器的最大宽度。我知道在css中,如果您稍后声明某些内容,则它优先。我想知道是否由于采购文件的顺序而没有观察到最大宽度的缺失。我尝试了不同的文件名,如 doc.css 和 xdoc.css,认为它们是按字母顺序提供的。这似乎没有帮助。
有没有办法让这个小的 css 改变并在我构建它时使用补充 ui 方法将它放入我的 antora 站点?
我希望使用补充 ui 方法,这样我们就可以随时了解 antora 的最新变化,并且只需对 max-width 进行微小的更改。我采用的方法需要用微小的变化构建 antora,并指向新的 zip 文件来构建 antora,而不是在公共 antora 存储库中采购当前最新的 antora。
对于调试,我还使用补充 UI 构建过程尝试了这种方法。我知道 !important 不被推荐,但我只是想弄清楚除了完整构建到 zip 文件之外,我是否可以得到一些工作。
document - 如何为不同的模块定义具有相同键的属性?
我想在不同的模块中使用相同的键属性,但值不同。
我在 antora.yml 中定义了属性,但似乎没有办法区分模块。
我应该怎么办?
pdf - PDF 嵌入在 asciidoc 的同一窗格中
我需要将 PDF 与所有其他文件一起嵌入 asciidoc 中。我可以添加 pdf 链接,但是当我单击它时,它会在浏览器的新选项卡中打开,而不是在同一选项卡和同一窗格中打开,以便更容易查看目录。使用链接添加 pdf 链接:https ://docs.antora.org/antora/2.3/asciidoc/link-attachment/
有什么办法可以做到这一点。
提前致谢!
gitlab - 无法将证书路径放入 antora-playbook.yml
这就是我的文档项目中我的 antora-playbook.yml 的内容:
不可能包含 gitlab 证书,例如:
它也不适用于系统环境变量:
那么,我怎样才能将证书放到 antora-playbook.yml 或我的文档项目中的其他任何地方?现在,使用命令时,一切都以 400 错误结束:antora antora-playbook.yml