问题标签 [asciidoc]

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 投票
2 回答
719 浏览

asciidoc - 如何使用 asciidoc 传递处理方括号?

Asciidoctor 正确呈现以下行。

当我像这样添加一个硬中断时,

第二行根本不渲染。

我该如何解决这个问题?

更新

到目前为止,我发现一个领先的空间确实需要工作。我不确定这是理想的效果。

0 投票
1 回答
663 浏览

markdown - 降价源代码标注,如 asciidoctor?

我真的很喜欢 asciidoctor 的标注,请参阅http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/,并在页面“带有标注的代码块”中搜索,单击“查看结果”。但是我使用 Ipython notebook 来写,Markdown 是不二之选。(通过“原始NBconvert”在Ipython Notebook中尝试了Asciidoctor,结果混乱。)看来我只需要Asciidoctor的源代码标注。所以我的问题是如何从Markdown获得类似的结果?

0 投票
1 回答
476 浏览

pdf - 如何使用 asciidoctor-fopub 生成封面图片图片

我正在尝试自定义我们的开发人员指南 pdf以使其首页看起来不错。我完全可以在 Photoshop 中将所有内容作为图像进行处理,因为 asciidoc 在这里的能力似乎非常有限。

不幸的是,尽管到处寻找,我似乎找不到一种方法来自定义封面或将其替换为适用于 asciidoctor-fopub 的图像。

烦人的是,这个用例在项目的自述文件中特别提到了https://github.com/asciidoctor/asciidoctor-fopub(在自定义 XSL 模板下),但除了“它在 XSL 中”。作为不熟悉 docbook 的人,我不知道从哪里开始。

asciidoctor-pdf有一个包含图像的标签,但它会在我们的文档上显示并生成垃圾(ToC 会覆盖所有内容)。

0 投票
2 回答
807 浏览

pdf-generation - 是否可以使用 Asciidoc 和 Fopub 将文本环绕在图像周围?

我使用 asciidoc 和 fopub 后端为 Codename One生成文档。HTML 生成非常简单,但是当我生成 PDF 时,我无法正确包装图像文本。

asciidoc的float属性和提示仅支持 HTML 输出。该align属性适用于 fop/docbook 后端,但不会像参数那样让文本环绕图像float

有没有办法对 fop PDF 输出进行文本换行?

0 投票
2 回答
388 浏览

pdf-generation - 如何在 asciidoc fop 中合并甚至禁用脚注链接

我有一个相当大的 asciidoc 文档,我将其动态转换为 PDF 以供我们的开发人员指南使用。由于文档通常引用我们开发人员指南中记录的 Java 类,因此我们将它们直接转换为文档中的链接,例如:

这在大多数情况下工作得很好,并且在 HTML 中看起来很棒,因为对类的每个引用都直接导致其 JavaDoc,从而使引用/指南过程更加简单。

但是,当我们生成 PDF 时,我们最终会在某些页面上出现类似这样的内容:

脚注地狱

通常我不会介意很多脚注,甚至是前一页的重复。但是,在这种情况下,指向 Container 的链接出现了 3 次。

我可以删除一些链接,但我宁愿不这样做,因为它们在网络版本上很有意义。由于我也不知道分页符将落在哪里,我宁愿自己不这样做。

这在我看来像是某处的错误,如果链接相同,则链接的脚注应该只生成一次。

如果这是要付出的代价,我可以删除文档中的所有链接脚注,尽管我宁愿能够根据具体情况执行此操作,因此某些链接仍可打印

0 投票
2 回答
4195 浏览

spring - 使用 Asciidoctor Maven 插件以 HTML 格式发布 API 文档时出现未解决的指令错误

我成功地使用 Spring RestDocs 编写了一个测试并生成了代码片段。

当我使用Asciidoctor Maven plugin以 HTML 格式发布 API 文档时,会生成 HTML 文档。

但是,HTML 显示以下错误。似乎我的包含没有按预期运行。我想知道有什么问题。

api-guide.adoc 中未解决的指令 - 包括::/opt/caweb/thoughtworks/go-agent/pipelines/xxx_Build/xxx-source/target/generated-snippets/creating-grouping/curl-request.adoc[]

这是 POM.xml 的 asciidoctor-maven-plugin 和 maven-resources-plugin部分

这是我的 api-guide.adoc 的包含部分:

谢谢您的帮助!

0 投票
2 回答
1412 浏览

gradle - Gradle 和 asciidoc

我对使用 Gradle 将我的 asciidoc 文件转换为 PDF 的选项有点困惑。有这个GitHub存储库,其中包含一组使用以下 Gradle 构建文件样式(摘录)的示例:

从这里(github)使用 Asciidoctor Gradle 插件。

另一方面,我们在此处(官方文档)或此处(mrhaki)使用此样式对 Asciidoctor Gradle 插件进行了描述:

那么哪一个是当前(和正确)的语法?如果我想生成 PDF 并包含图表,我应该使用哪一个?

(只是说清楚:我只有非常有限的 Gradle 经验;)

0 投票
1 回答
556 浏览

asciidoc - 从 asciidoc 中的 csv 加载的表有奇怪的字符输出

我想使用 asciidoc 来生成表格。我使用 asciidocfx。我创建了 2 个相同的表,一个加载外部 csv 文件,而另一个是在 asciidoc 中创建的简单表。问题是,加载的 csv 文件中的表会为这些字符“...”生成一个 �。使用 asciidoc 创建的表不会为“...”生成该符号

这里是文字

table.csv 的内容

html 输出的片段。

0 投票
0 回答
208 浏览

pdf-generation - AsciiDoc: How can I place graphical hints on an image

I am using AsciiDoc with Asciidoctor Gradle Plugin to generate technical documentation as PDF.

When I used M$ Word, I could easily place forms on an image, for example

  1. colored rectangles,
  2. boxes with numbers or
  3. even links to sections within the document,

to better point out interesting areas within the image.

Example:

Example image: A mockup with two rectangles and two links

On the example image I have placed two rectangles and each one contains a link (starting with the word «Dialogbereich») leading to a other sections within the document.

Is it possible to achieve something like this (directly) in AsciiDoc?

  1. Note that the answers to asciidoc: how to add callouts asciidoc to image do not apply here as the Asciidoctor PDF backend does not use DocBook to generate the PDF.
  2. I know I could create a layered image in GIMP to at least place the rectangles. However, that wouldn't help me with the links.
0 投票
1 回答
382 浏览

xml - 是否有 XML Schema (xsd) 到 AsciiDoc 转换器?

我想知道是否存在将 XML xsd 中包含的描述转换为 AsciiDoc 表的工具,以便可以将其包含在整个 AsciiDoc 文档中。

好处当然是只有单一的描述来源,避免复制和粘贴。