mdsh for Mac 版
Markdown shell 预处理器
mdsh 是什么
mdsh 是一个 Markdown 预处理器,它扩展了 Markdown 语法,用来把 README 里那些需要手动维护的内容自动化。写文档时经常要嵌入其他文件的代码片段,或者展示某条命令的输出,这些内容一旦源文件变了就得手动同步。mdsh 的做法是:在 Markdown 里用自然、接近日常书写的语法标记这些块,运行 mdsh 后相关块会就地更新,而不是生成一个新文件,因此操作是幂等的。
它的命令由输入方式和输出方式组合而成,可以执行脚本并生成指定语言的代码块、输出原始 Markdown,或者把数据展开成 shell 变量供后续命令使用。命令可以放进行内代码块、代码块、单行注释、多行注释块和链接等容器中,支持通过 stdin 把代码块传给命令处理,也支持用 shebang 跑非 bash 的脚本语言。
整体上它有点像面向 shell 命令的文学编程或 Jupyter notebook:文件会稍微啰嗦一点,换来的是输出内容可以自动刷新。适合需要在 README 中嵌入代码、命令输出并希望保持同步的开发者。
它的命令由输入方式和输出方式组合而成,可以执行脚本并生成指定语言的代码块、输出原始 Markdown,或者把数据展开成 shell 变量供后续命令使用。命令可以放进行内代码块、代码块、单行注释、多行注释块和链接等容器中,支持通过 stdin 把代码块传给命令处理,也支持用 shebang 跑非 bash 的脚本语言。
整体上它有点像面向 shell 命令的文学编程或 Jupyter notebook:文件会稍微啰嗦一点,换来的是输出内容可以自动刷新。适合需要在 README 中嵌入代码、命令输出并希望保持同步的开发者。
如何安装 mdsh
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
该项目暂未在 GitHub 发布 Release。
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| mdsh | 0.9.2 | MIT | 命令行 | 1 |
| libdshconfig | 0.20.13 | GPL-2.0-or-later | 命令行 | 0 |
| desk | v0.6.0 | MIT | 命令行 | 1 |
| beakerlib | 1.33.4 | GPL-2.0-only | 命令行 | 13 |