jupyterbook目录栏
时间: 2025-02-09 18:13:18 浏览: 41
### 如何在 JupyterBook 中配置和使用目录栏
为了使读者能够更方便地浏览和导航 Jupyter Book 的内容,在项目中添加一个清晰的目录结构是非常重要的。通过 `_toc.yml` 文件来定义书籍的内容层次以及各个章节之间的关系。
#### 创建 TOC 文件
创建名为 `_toc.yml` 的文件放在项目的根目录下,该文件用于指定整个书目的结构。下面是一个简单的例子:
```yaml
format: jb-book
root: intro
chapters:
- file: introduction
sections:
- file: section1
subsections:
- file: sub-section1a
- file: sub-section1b
- file: chapter2
parts:
- caption: Part I Title
chapters:
- file: partI/chapterA
```
此 YAML 配置指定了不同级别的标题及其对应的 Markdown 或者笔记本文件位置[^1]。
#### 使用 `jupyter-book toc` 命令自动生成大纲
对于已经有一定规模的文档库来说,手动编写 `_toc.yml` 可能会很繁琐。这时可以利用命令行工具来自动生成初始版本的大纲:
```bash
jupyter-book toc mybookname/
```
这将会扫描给定路径下的所有支持格式的文件,并尝试构建合理的层级关系写入到 `_toc.yml` 中去。
#### 自定义侧边栏行为
除了基本的树状结构外,还可以进一步调整左侧菜单的行为方式。比如设置某些部分折叠显示、改变图标样式等。这些高级选项同样是在 `_config.yml` 中完成配置的。
#### 测试与预览
每次修改完 `_toc.yml` 后都应该重新构建一次网站以查看效果。可以通过如下指令快速启动本地服务器来进行实时预览:
```bash
jupyter-book serve .
```
这样就可以即时看到更改后的页面布局是否满足需求了。
阅读全文
相关推荐










