【发布时间】:2021-01-10 10:35:56
【问题描述】:
是否可以以任何方式插入指向 reStructuredText 文件中锚点的 Markdown 文件的链接?
我有一个包含 .rst 和 .md 文件的项目文档,并且我使用的是 m2rr Sphinx 扩展名,但它似乎只支持文件内 rst 锚链接。
有什么办法可以做到吗?
【问题讨论】:
标签: python markdown anchor python-sphinx restructuredtext
是否可以以任何方式插入指向 reStructuredText 文件中锚点的 Markdown 文件的链接?
我有一个包含 .rst 和 .md 文件的项目文档,并且我使用的是 m2rr Sphinx 扩展名,但它似乎只支持文件内 rst 锚链接。
有什么办法可以做到吗?
【问题讨论】:
标签: python markdown anchor python-sphinx restructuredtext
Markdown 本身不支持跨文档交叉引用任意位置。
一种解决方法是插入一个基于 HTML 的锚。
[My Label](/root-relative-url.html#anchor-in-page)
另一种选择是使用MyST。在这里,您将不使用 markdown 作为锚点,而是使用 MyST syntax 或嵌入 reST 语法。
目标标头使用以下语法定义:
(header_target)=然后可以使用 ref 内联角色来引用它们:
{ref}`header_target`默认情况下,引用会使用目标的文本(如章节标题),也可以直接指定文本:
{ref}`my text <header_target>`
【讨论】: