将 Markdown 文件转换为 HTML,包含十几种内置主题。
功能
- 包括适用于 Markdown 的 15+ 种预置 CSS 样式表,请参阅自述文件的底部获取屏幕截图。
- 重复使用样式表或使用
generate-md
工具将 Markdown 文件夹转换为 HTML,方法是使用一种内置布局或自定义布局。
- 完全静态输出很容易在任何地方托管。
- 元数据支持:每个文件都可以在页眉部分中包含其他元数据,例如页面标题和作者姓名,这些信息随后可以用于该布局。
布局功能
- 通过 highlight.js 针对代码语法高亮提供内置支持;默认情况下,所有布局都包含一个 GitHub 风格的代码高亮主题。
- 从 Markdown 标题生成内置目录,通过在自定义布局中替换
{{> toc}}
偏部分,可以进行完全自定义。
- 针对用 Markdown 编写的标题生成功内置页眉 id 和锚点;所有布局都支持通过页眉悬停链接显示 URL。
- 通过
--highlight-*
支持针对代码块呈现自定义逻辑;这可用于实现以某种有趣的方式呈现代码块内容的自定义块。
- 从 Markdown 标记中的第一个标题自动检测文档标题。
- 通过
--layout
基于现有布局创建具有下列功能的自定义布局
- 针对布局、帮助程序和偏部分全面的 Handlebars 支持
- 通过
toc
偏部分完全自定义目录模板
- 通过
{{asset 'path'}}
帮助程序支持相对路径生成