📜  布尔玛 Dropup(1)

📅  最后修改于: 2023-12-03 15:25:25.499000             🧑  作者: Mango

布尔玛 Dropup

介绍

布尔玛 Dropup 是一款用于编写交互式文档的工具集,它使用 Markdown + Python 的方式,允许你在文档中嵌入交互式的 Python 代码块,使得文档中的代码可以被直接执行。

布尔玛 Dropup 所支持的功能包括但不限于:

  • 启动/关闭内置的 Web 服务,方便查看文档中嵌入的交互式组件
  • 嵌入 Python 代码块,并支持执行代码
  • 支持使用全局变量来共享代码块之间的数据
  • 支持使用自定义模板来生成文档页面
  • 支持 Python 对象图的生成和展示

如果你需要编写一份使用 Python 实现的文档或者教程,并且希望读者能够直接运行代码来了解某个概念或者操作方式,那么布尔玛 Dropup 是一个非常好的选择。

安装

目前,布尔玛 Dropup 已经发布到了 PyPI,你可以直接使用 pip 安装:

pip install bool-marzipan-dropup
使用

假设你有一份 Markdown 文档,其中包含以下内容:

# 示例文档

这是一个示例。

```python
a = 1
b = 2
c = a + b
print(c)
print('hello, world!')

你可以将这份 Markdown 文档保存为 test.md 文件,然后使用以下命令来打开文档:

```shell
bsub

文档会在默认浏览器中打开。在文档中,你可以看到两个 Python 代码块,其中第一个代码块会输出 3,第二个代码块会输出 hello, world!。

高级用法

布尔玛 Dropup 的高级用法包括但不限于:

  • 自定义模板
  • 编写 Python 脚本来生成文档
  • 支持 Markdown 扩展
  • 支持自定义启动参数

具体用法请参考官方文档。

参考资料