【问题标题】:Paginating a long Markdown document?对长 Markdown 文档进行分页?
【发布时间】:2013-09-21 08:23:35
【问题描述】:

我正在写handbook for hotplate。它会比我预期的要大得多。所以,我想把文档“分解”成几个子文档。

我正在考虑根据文档的#titles 对文档进行切片。所以:

# Main title

Under main title

## Installation
Under installation

## Initial use
Under initial use

会生成三个文件:

  • maintitle.html——带有指向installation.html和initialuse.html(“next”)的点列表
  • installation.html -- 带有指向 maintitle.html(“prev”)的链接和指向 initialuse.html(“next)”的链接
  • initialuse.html -- 带有指向 installation.html(“prev”)的链接

它基本上将 Markdown 文件分成多个部分。

这样的东西已经存在了吗?

【问题讨论】:

  • Pure Markdown 没有提供这样做的机制,可能是因为它不是为编写长文档而设计的。考虑到这一点而设计的东西是reStructuredText,它与 Markdown 共享一些设计目标(例如,旨在以原始形式易于人类阅读)并被设计为通用文档处理系统。语法与 Markdown 没有太大区别,但它的功能要强大得多。对于任何严肃、冗长的写作,我真的建议使用这个(或类似的工具)而不是 Markdown。
  • 另外,reStructuredText 为including documents within other documents 提供了一种机制。

标签: documentation markdown


【解决方案1】:

“不”(3 年后)我想这将有助于未来有同样问题的人!

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2020-11-16
    • 2019-03-12
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-06-13
    • 2011-07-23
    相关资源
    最近更新 更多