创建ASCII文档的索引页面

时间:2018-06-07 06:21:15

标签: asciidoc asciidoctor asciidoctor-pdf

我在不同的位置有很多ASCII文档,我想创建一个应该呈现这些文档的索引页面。但这里的条件是我想列出索引页面上的所有文档链接,如果用户点击任何链接,那么只应显示文档。我不想在内容列表下方显示文档。我只想在索引页面上显示内容表。

有没有办法做到这一点?

1 个答案:

答案 0 :(得分:0)

如果我理解正确,您希望生成一个多文档网站,但您希望索引页面只显示TOC,其他文档在其他地方提供。我相信获得此效果的最佳方法是使用DocBook工具链生成分块的XHTML输出。我相信这应该可以使用Asciidoctor tools,但我只使用原始的(基于Python的)AsciiDoc渲染工具实现了这个特定的后渲染工具链,documented here。此设置可配置为生成链接到分块输出的TOC索引页(您可以配置分块级别)。

正如您已经想到的那样,AsciiDoc的自动TOC生成仅适用于本文档,该文档要求包含从属文档以获取TOC标题。我可以想办法对游戏进行排序,例如只包含所包含文档的标题(include::path/to/document.adoc[lines=1]),然后用CSS或其他东西隐藏那些标题。问题是,TOC中的链接将指向内部,因此您需要以某种方式处理。

另一种方法是使用任何支持或可以轻松扩展以支持AsciiDoc的static-site generators。您所谈论的并不是我所知道的开箱即用的功能,但它们至少可以生成有组织的TOC类型导航。