探索Literate Markdown Tangle:代码与文档的新融合
Literate Markdown Tangle(LMT) 是一个创新的工具,它将Markdown与编程风格相结合,使程序员能够在文档中以清晰易读的方式编写代码。这种** literate programming** 的理念让开发者可以在保持代码可读性的同时,增强文档的完整性。
安装LMT
LMT是一个基于Go语言开发的自包含程序,源码和这个README文件一起存储在GitHub仓库中,用于自我构建。首先确保你的环境中已经安装了Go语言,然后执行以下命令:
git clone https://github.com/driusan/lmt
cd lmt
go build
这将在当前目录下创建名为lmt
的二进制文件,你可以通过-o $path
参数来指定不同的输出位置。
对于Nix(OS)用户,项目还提供了一个shell.nix
文件,可以用来编译项目。
功能演示
为了体验LMT的工作原理,请将此README文件复制到一个空目录,并运行lmt README.md
。你会看到从Markdown文件中的代码块中提取出来的文件出现在当前目录。这种过程在literate编程中被称为“tangling”。
LMT是语言无关的,下面的示例使用非常基础的C++来展示其他语言的应用。
文件定向与追加
比如这段带有cpp hello.cpp +=
前缀的代码块:
<<<copyright>>>
<<<includes>>>
int main() {
<<<body of main>>>
}
cpp
表示该代码块为C++,在Markdown渲染时会有相应的语法高亮,在LMT中则会添加语言特定的预处理指令。hello.cpp
指定了代码块将会被写入到hello.cpp
文件中。+=
表示如果文件已存在,则追加内容到文件末尾,如果不存在则新建。
宏引用
像<<<...>>>
这样的序列称为“宏参考”。LMT的“宏”是一个可以从代码块中提取并插入到其他地方的变量。如上例中的<<<body of main>>>
,未定义时会有警告,但定义后会被替换。
宏内容
以下代码块定义了body of main
的值:
std::cout << "Hello, werld!" << std::endl;
双引号表示这是一个宏,而没有+=
意味着会覆盖之前的定义。
追加到宏
使用+=
,我们可以向宏添加新的内容,例如在includes
宏后面添加更多头文件:
#include <numeric>
隐藏内容
隐藏内容如注释中的版权信息不会显示在最终文档中,但仍会被提取出来:
// Copyright 2020 Me, myself, and I
可选的Tangle与不可选的
LMT允许你对任意语言字符串和文件名进行编码,以实现不同需求。不指定语言或目标,代码块就不会被打包到任何地方。
应用场景
LMT特别适用于:
- 文档驱动的开发,它可以轻松地将代码解释与实现结合在一起。
- 教程编写,读者可以直接查看和理解代码细节。
- 开源项目,提供清晰的、有注解的代码以提高代码透明度。
- 快速原型设计,代码与说明文档可以同时修改,减少切换成本。
项目特点
- 语言无关:LMT支持所有语言的代码块,只需指定语言名称。
- 扩展性:通过宏引用,可以在多个代码块之间传递和组合代码。
- 隐藏内容:在不影响文档展示的情况下,隐藏需要tangle的内容。
- 灵活的代码组织:追加内容、定义新宏等操作,让代码结构更自由。
LMT不仅是一个工具,更是一种编程哲学。它将代码和文档紧密集成,让开发变得更直观,更易于理解和维护。立即尝试LMT,提升您的代码写作体验吧!
鸿蒙开发工具大赶集
本仓将收集和展示鸿蒙开发工具,欢迎大家踊跃投稿。通过pr附上您的工具介绍和使用指南,并加上工具对应的链接,通过的工具将会成功上架到我们社区。012hertz
Go 微服务 HTTP 框架,具有高易用性、高性能、高扩展性等特点。Go01每日精选项目
🔥🔥 每日精选已经升级为:【行业动态】,快去首页看看吧,后续都在【首页 - 行业动态】内更新,多条更新哦~🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~029kitex
Go 微服务 RPC 框架,具有高性能、强可扩展的特点。Go00Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie057毕方Talon工具
本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python040PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython06mybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区018- DDeepSeek-R1探索新一代推理模型,DeepSeek-R1系列以大规模强化学习为基础,实现自主推理,表现卓越,推理行为强大且独特。开源共享,助力研究社区深入探索LLM推理能力,推动行业发展。【此简介由AI生成】。Python00
热门内容推荐
最新内容推荐
项目优选









