在 Sphinx 中使用 MyST 替换

Question

MyST允许以 markdown 格式编写 sphinx 文档。是否可以将其与替换结合起来？

Answer 1

对的，这是可能的。

首先，您需要substitution在conf.py文件中启用扩展名：

# Don't forget to activate `myst_parser` as well
extensions = [
    # ...
    'myst_parser'
]
myst_enable_extensions = [
    # ...
    'substitution'
]

仍然在您的conf.py文件中，您必须在myst_substitutions字典中定义您的替换。

myst_substitutions = {
    'my_name': 'Luiz Oliveira'
}

最后，在 Markdown 文件中，您可以通过将密钥传递到双大括号 ( {{YOUR_SUB_KEY}}) 内来使用替换，如下所示：

<!-- This is my markdown file -->
This document was written by {{my_name}}.

这将生成输出：

本文档由路易斯·奥利维拉 (Luiz Oliveira) 撰写。