asciidoc,doctoolchain,target github readme.adoc-如何将包含include



GitHub支持asciidoc自述文件,但它看起来像"包括";不支持。我想使用doctoolchain,它可以渲染并导出为html和pdf(可能还可以导出为其他格式(。这个工具很好用。

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

但我认为最好将结果作为一(1(个readme.adoc文件。

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

我认为内部asciidoctor收集并合并所有这些";包括";文件。所以,也许这个文件已经在任何地方可用了?doctoolchain生成文件夹仅包含目标文件。

您是对的,关于github不支持include的原因有很长的争论。

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

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

此脚本可用于解析includes并生成一(1(个输出文件:

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

有关脚本的一些信息以及接下来可能采取的步骤,您可以在此处阅读:用于预处理的AsiiDoc后端(AsciiDoc 2 AsciiDoc(

要使用它,必须安装ruby和asciidoc:asciidoctor.org/#安装

最新更新