阅读mdBook生成的图书
本章介绍了如何与 mdBook 制作的图书进行交互。假设您正在阅读一本 HTML 书籍。这相对于其他输出格式(如 PDF),选项和格式将有所不同。
电子书是由章节组成的。每章都是一个单独的页面。章节可以嵌套子章节。通常,每个章节将组织成一系列标题以细分一章。
导航
有很多途径可以导航到图书的章节
左侧的侧边栏提供了所有章节的列表。 点击任何章节标题将显示这一章节。
如果窗口太窄,边栏可能不会自动显示,尤其是在移动端上。 在这种情况下,可以按下页面左上角的菜单图标(三个水平条 类似粗体 “三”)以打开和关闭侧边栏。
正文页面底部的箭头按钮可用于导航到上一章或下一章。
键盘上的向左和向右箭头键也可用于导航到上一章或下一章。
顶部菜单条
在页面顶部的菜单条提供了一些图标,用于与图书的交互。下方展示的图标是否显示,取决于图书生成时的制作设定。
图标 | 说明 |
---|---|
打开或关闭显示章节列表的侧边栏。 | |
打开颜色主题列表 | |
打开搜索框,对全书内容进行搜索 | |
打开 浏览器打印预览界面,打印整本书。 | |
打开指向托管图书源代码的网站的链接。 | |
打开一个页面以直接编辑您当前正在阅读的页面的源代码。 |
点击菜单栏(除去图标的地方)会将页面滚动到顶部。
搜索
每本书都有一个内置的搜索系统。 按菜单栏中的搜索图标()或按键盘上的“S”键将打开一个输入框,用于输入搜索词。 键入某些术语将实时显示匹配的章节和部分。
点击任何搜索处的结果都将跳转到该部分。 向上和向下箭头键可用于导航结果,Enter 将打开突出显示的部分。
加载搜索结果后,匹配的搜索词将在文本中突出显示。单击突出显示的单词或按 Esc 键将删除突出显示。
代码块
mdBook 制作的书籍通常用于编程项目,因此它支持突出显示代码块和示例。 代码块可能包含几个不同样式的图标,用于读者与它们进行交互:
Icon | Description |
---|---|
将代码块复制到本地剪贴板中,允许复制粘贴到另一个应用程序中。 | |
对于 Rust 代码示例,点击后将执行示例代码,并在示例下方显示输出结果。(see playground). | |
对于 Rust 代码示例,这将显示或隐藏“隐藏”代码的可见性。有时,较大的示例会隐藏与所说明内容不是特别相关的行。 (参考 hiding code lines). | |
对于 可编辑的代码示例,这将撤消您所做的任何更改。 |
下面时一个简单的例子:
#![allow(unused)] fn main() { println!("Hello, World!"); }