目标github readme.adoc -如何在没有包含的情况下将包含的asciidoc文件导出到一个文件中？

Question

GitHub支持asciidoc自述文件，但似乎不支持"include“。我想使用doctoolchain，它可以渲染和导出到html和pdf (也可能是其他格式)。这个工具工作得很好。

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

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

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

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

Answer 1

你说得对，有一个long讨论了为什么github不支持include。

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

• configure your docDir/Config.groovy
  • inputFiles应具有docbook defined
  • inputFiles = [[file: 'yourfile', formats['docbook']]]

• 运行文档工具链任务generateDocbook -它在文档中的某个位置根据生成的文档创建???.xml文件再次创建一个asciidoctor文件-` `pandoc -f docbook -t asciidoctor -o `pandoc确保它自动运行，并定期提交
• 现在您已准备好

Answer 2

此脚本可用于解析包含并生成一(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