如何从Python程序中将数据添加到Markdown文件中？

Question

我想在Markdown中直接获取并显示一个Python文件中的多行字符串，这样我就不用每次更新内容时都去手动修改Markdown文件以保持与文件内容一致。

由于我对Markdown不太熟悉，所以尝试了以下两种方法：

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


以及

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

我希望它能显示出mystring所代表的数据，但实际上它只是显示了Python代码本身。

请注意，mymodule是同一目录下的另一个文件，其中mystring是一个多行字符串。

David Arenburg · Answer

据我所知，标准Markdown不支持直接从Python文件中读取并插入多行字符串到Markdown文档中。然而，在使用MyST Markdown时，你可以构建内联表达式，并通过{eval}指令来实现你的需求。

假设在名为mymodule.py的Python文件中有如下定义：

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

在安装了JupyterLab的MyST扩展插件后（例如来自GitHub的此扩展），你可以在JupyterLab中这样做：

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

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

注意：由于打印出的字符串被视为纯文本，换行符可能不会被渲染成实际的换行效果。

内联表达式的演示结果

另一种选择是利用Jupyter Book，它具有{code-cell}指令，可以执行Python代码并在文档中嵌入输出。关于如何使用{code-cell}及其更多细节，请参阅Jupyter Book官方文档和其快捷参考指南了解更多内容。

Felix · Answer

Markdown自身是一种文本格式化工具，并不执行代码。

``` 这样的语法仅用于突出显示Python代码块的语法。
如果你想在Markdown文档中添加Python程序中的数据，你需要借助额外的工具来运行Python代码！

一种方案是在编写Markdown文件时结合Python脚本。例如，在一个名为`generate_markdown.py`的文件中：

```python
import mymodule
mystring = mymodule.mystring

# 在此处编写代码，使用mystring生成Markdown文件

这里推荐一个非常适合此类任务的工具——Jinja。它是一个强大的模板引擎，并以Python包形式提供，即Jinja2。

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

Hello {{ data.mystring }}

然后将这个文件传入Jinja，并携带mystring变量值，Jinja将会生成最终的example.md文件：

Hello World

如果mystring包含文本"World"的话。

诚实地讲，初次接触Jinja时需要一些时间学习。可以从他们的官方网站开始了解，同时还有一个名为jinja-cli的命令行工具作为Python包，这是初学者快速入门的好方法。

对于您的需求，如果不打算使用Jinja，也可以直接在一个模板文件中查找替换占位符如{{ data.mystring }}（或类似MY_PLACEHOLDER）来生成最终的Markdown文件。虽然Jinja提供了许多实用功能，但如果简单定制能满足您的需求，您也可以选择简单的方案。

另外，如果您希望保留代码在Markdown文档内部，可以考虑使用像Pweave这样的工具，它可以将```python代码块的输出内容整合到生成的HTML中。