在带有MyST的Sphinx中使用替换

Question

MyST允许以标记形式编写sphinx文档。有没有可能把它和替换结合起来？

Answer 1

是的，这是可能的。

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

# 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}}.

这将生成输出：

本文档由路易斯·奥利维拉撰写。