推荐使用Codebraid - 在Pandoc Markdown中实现可执行代码
codebraidLive code in Pandoc Markdown项目地址:https://gitcode.com/gh_mirrors/co/codebraid
项目介绍
Codebraid是一个基于Python的程序,它开创性地让Pandoc Markdown文档中的代码变得可执行。只需要在代码块属性中添加一个特定的类,然后使用codebraid
代替pandoc
进行文档转换,即可轻松实现从Markdown到其他格式的转换。该工具不仅几乎支持所有pandoc
选项,还可以将这些选项直接传递给pandoc
。
Codebraid提供的集成编辑器支持包括Codebraid Preview for VS Code,以及详细的Codebraid网站上的额外示例和文档,便于您更好地理解和利用这个强大的工具。
项目技术分析
Codebraid内置了代码执行系统,目前支持Python 3.7+、Julia、Rust、R、Bash、JavaScript、GAP和SageMath。此外,它还能够通过Jupyter内核执行代码,支持如绘图等丰富的输出形式。开发工作在GitHub上公开进行,供开发者贡献和跟踪项目进展。
项目及技术应用场景
Codebraid是科研论文、教程、报告以及任何需要展示和解释代码运行结果的文档的理想选择。无论您是在编写Python脚本,还是在处理R的数据分析,或是演示JavaScript交互式功能,都可以借助Codebraid实时展示代码执行结果,大大提升了文档的互动性和可信度。
项目特点
- 多语言支持 - 不仅限于一种编程语言,您可以在同一文档中无缝切换。
- 跨代码块变量持久化 - 变量值在不同代码块之间保持,确保代码逻辑连续性。
- 无顺序执行 - 确保代码按照其在文档中的顺序执行。
- 无预处理器或自定义语法 - 使用标准Markdown语法,避免因特殊格式引起的冲突。
- 兼容任意文本编辑器 - 无需依赖特定环境,适用于任何您喜欢的文本编辑器。
- 易于调试 - 错误信息会直接显示在文档中,便于快速定位问题。
- 简单扩展 - 添加新语言支持只需几分钟,创建一个配置文件指定运行程序、文件扩展名和输出方式。
安装与使用
安装Codebraid非常简单,通过pip3 install codebraid
或pip install codebraid
即可。运行时,只需像平常一样调用codebraid pandoc
,并传递相应的选项。
现在,让我们一起探索Codebraid带来的无限可能,让您的Markdown代码跃然纸上,生动呈现执行过程和结果。立即试用,体验更高效、更具互动性的文档编写方式!
codebraidLive code in Pandoc Markdown项目地址:https://gitcode.com/gh_mirrors/co/codebraid