返回介绍

SUMMARY.md 文件

发布于 2024-10-04 20:04:44 字数 2607 浏览 0 评论 0 收藏 0

GitBook使用一个SUMMARY.md文件来定义文档的菜单。

虽说在官方文档中,它是可选的,但是它相当重要,控制了左边菜单栏的显示内容。

它通过 Markdown 中的列表语法来表示文件的父子关系。

紧凑型的

# Summary
* [Introduction](README.md)
* [Part I](part1/README.md)
    * [Writing is nice](part1/writing.md)
    * [GitBook is nice](part1/gitbook.md)
* [Part II](part2/README.md)
    * [We love feedback](part2/feedback_please.md)
    * [Better tools for authors](part2/better_tools.md)

分散型的

也可以通过使用 标题 或者 水平分割线 标志将 GitBook 分为几个不同的部分。

你看到左侧菜单栏的部分 SUMMARY.md文件

# Summary

### Part I

* [Part I](part1/README.md)
    * [Writing is nice](part1/README.md#writing)
    * [GitBook is nice](part1/README.md#gitbook)
* [Part II](part2/README.md)
    * [We love feedback](part2/README.md#feedback)
    * [Better tools for authors](part2/README.md#tools)

### Part II

* [feedback](part2/feedback.md)
* [tools](part2/tools.md)

----

* [Last part](part3/last.md)

自动生成

如果你的 md 文件是少量的,自己编写 SUMMARY.md 文件当然不费事。

但是 md 文件数量非常多时,你可能希望自动生成这些内容,可以参见 插件 summary 部分关于自动生成菜单 summary 文件的介绍。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文