如何将Python程序中的数据添加到Markdown中？

Question

我想在Markdown中获取一个Python文件中的多行字符串并显示出来，这样就不需要不断更新Markdown文件以保持与文件内容一致。由于我刚接触Markdown，所以在这方面经验较少。

我尝试了两种方法：

```{python}  
import mymodule  
print(mymodule.mystring)


以及

```markdown
```python
import mymodule
print(mymodule.mystring)

我希望它能直接显示出mystring所代表的数据，但实际效果是它仅显示了Python代码本身。

请注意，mymodule是同一目录下的另一个文件，而mystring是该文件中定义的一个多行字符串

CodeWizard · Answer

据我所知，Markdown 本身并不支持您想要实现的功能。但在 MyST Markdown 中，您可以利用 {eval} 指令构建内联表达式：

在 mymodule.py 文件中：

mystring = """StackOverflow
https://stackoverflow.com/"""

在 JupyterLab（安装了这个扩展后）中：

# 第一个单元格（代码）
import mymodule

# 第二个单元格（Markdown）
{eval}`mymodule.mystring`

注意：由于输出的字符串被视为纯文本，换行符不会被渲染

此外，您还可以使用 Jupyter Book，它提供了一个 {code-cell}指令（更多详情请参阅此处）。

eipi10 · Answer

Markdown 本身是一种文本格式化工具，并不能直接运行代码。使用 ```python 只是为了对 Python 代码块进行语法高亮显示。

如果你想在 Markdown 中添加来自 Python 程序的数据，就需要借助额外的工具来执行 Python 代码！

一种方法是在 Python 脚本中生成 Markdown 文件。例如，在 generate_markdown.py 文件中：

import mymodule
mystring = mymodule.mystring

# 在此处编写代码以利用 mystring 生成 Markdown 文件

对于此类需求，一个很酷的工具是 Jinja，它是一个名为 Jinja2的 Python 包。

首先创建一个类似 example.md.j2 的 Markdown 模板文件：

Hello {{ data.mystring }}

然后可以将此文件与 mystring 一起传递给 Jinja，它将生成 example.md 文件：

Hello World

如果 mystring 包含文本 "World"。

坦诚地说，当我首次在一个项目中使用 Jinja 时，花了一段时间学习。你可以从官方网站开始学习，并且还有一个名为 jinja-cli的命令行工具，作为熟悉该工具的一个好途径，在开始编写生成文档的 Python 代码之前可以先尝试一下。

针对你的具体需求，你甚至可以直接跳过 Jinja，对模板文件中的占位符（如 {{ data.mystring }} 或任何其他类似 MY_PLACEHOLDER）进行查找替换，从而生成最终的 Markdown 文件。虽然 Jinja 提供了更多可能有用的特性，但如果你的需求较为简单，也可以选择自定义和简化的方法。

另一种不同方法是，如果你想让代码保留在 Markdown 文档内部，可以使用类似 Pweave 的工具生成包含 Python 代码块输出的 HTML。

据我所知，Pweave 是从 Markdown 生成 HTML 的，因此，如果你需要输出为 Markdown 文件（比如 GitHub 仓库的 README.md），那么这可能不是适合你的工具。不过，Pweave 具备根据 Python 代码生成可视化的能力，看起来非常实用。