asciidoc，doctoolchain，目标 github readme.adoc - 如何将包含包含的 asciidoc 文件导出到一个不包含的文件中？

如何解决asciidoc，doctoolchain，目标 github readme.adoc - 如何将包含包含的 asciidoc 文件导出到一个不包含的文件中？

GitHub 支持 asciidoc 自述文件，但貌似不支持“include”。 我想使用 doctoolchain，它可以呈现和导出为 html 和 pdf（也可能是其他格式）。这个工具很好用。

我可以使用 raw.githack.com 来显示从 GitHub 存储库生成的 html 文件。

但我认为将结果也作为一 (1) 个 readme.adoc 文件是一个好主意。

如何导出为一 (1) 个 asciidoc 文件，我可以将其用作自述文件，以便 github 渲染并显示？最好是使用 doctoolchain，当这个工具将呈现我的文档时，它也可以生成 one-file-asciidoc-documentation。

我认为内部 asciidoctor 收集并合并所有这些“包含”文件。那么也许这个文件已经在任何地方可用了？ doctoolchain 构建文件夹仅包含目标文件。

解决方法

您说得对，long 讨论了为什么 github 不支持 include。

您可以使用 doctoolChain 和 pandoc(https://pandoc.org/) 实现您的目标。需要以下步骤：

• 配置您的 docDir/Config.groovy
  • inputFiles 应该定义了 docbook
  • inputFiles = [[file: 'yourfile',formats['docbook']]]
• 运行 doctoolchain 任务 generateDocbook - 它会在 docDir/build 的某处创建 ???.xml 文件
• 再次从生成的 docbook 生成一个 asciidoctor 文件 - `pandoc -f docbook -t asciidoctor -o
• 确保它自动运行并定期提交
• 现在你准备好了

,

此脚本可用于解析包含并生成一 (1) 个输出文件：

https://github.com/asciidoctor/asciidoctor-extensions-lab/blob/master/scripts/asciidoc-coalescer.rb

您可以在此处阅读有关脚本和可能的后续步骤的一些信息： AsciiDoc Backend (AsciiDoc 2 AsciiDoc) for preprocessing

要使用它，必须安装 ruby​​ 和 asciidoc： asciidoctor.org/#installation