如何在子文件夹的Markdown文件中引用上级文件的小节(Jupyter Book)
Jupyter Book跨文件引用Markdown章节的方法
针对你的文件结构(parent.md在根目录,child.md在content/子目录),可以通过以下两种方式实现引用:
方法一:基础相对路径+锚点链接
直接在child.md中使用相对路径指向parent.md,并加上章节自动生成的锚点:
[查看parent中的sub-section章节](../parent.md#sub-section)
- 路径说明:
../用于从content/目录回到上级目录,定位到parent.md - 锚点规则:Jupyter Book会自动将章节标题转为小写,空格替换为连字符作为锚点,所以
## sub-section对应的锚点是#sub-section
方法二:Jupyter Book规范交叉引用(推荐)
这种方式支持自动同步章节标题,更适合书籍类文档:
- 先在
parent.md的目标章节添加自定义标签:
# Main section ## sub-section {#parent-sub-section}
这里{#parent-sub-section}是自定义的唯一标签,可自行命名。
- 在
child.md中使用交叉引用语法:
- 直接引用(自动显示章节标题):
{ref}`parent-sub-section`
- 自定义显示文本:
{ref}`跳转到parent的子章节 <parent-sub-section>`
完成后运行jupyter-book build .构建书籍,点击引用链接即可跳转到parent.md对应的章节。
内容的提问来源于stack exchange,提问作者user308827
相关产品推荐
相关产品推荐

