docuowl

Docuowl

Docuowl 从 Markdown 文件生成静态的单页文档

理由

作为 Stripe 所制作的文档风格的长期粉丝, 而 Markdown 则是我决定用作创建漂亮文档的基础。 一个生成器,其输出类似于 Stripe 的内容。Stripe 还慷慨地允许我使用其 API。 为了使用他们的布局,所以在这里要向他们表示衷心感谢!♥️

演示

要看示范吗?一个简单的示范版可在 https://docuowl.github.io/demo/ 找到!

安装

煮浓

要使用 Homebrew 安装 Docuowl,请执行以下命令:

brew install docuowl/tap/docuowl

手动

请参阅 发行版 页面以获取 最新版本。

文档组织 Docuowl 以一个目录作为输入。这个目录中每个部分或组都应该有一个目录。每个组可能有子部分，它们也必须放在目录中。每个 部分 必须有一个 content.md 文件，其中包含该部分的前缀信息，以及一个可选的 sidenotes.md 文件，它将渲染到该部分的右侧。前缀信息必须至少包含一个 Title 属性，以及一个可选的 ID 属性，其中包含该部分的唯一标识符。每个 组 必须包含一个单个 meta.md 文件，其中包含类似于部分的前缀信息，以及可选的内容，位于前缀信息之后。

例如，以以下目录树为例：