简介
mdx 是一个强大的工具,它允许你在 Markdown 文件中直接编写并执行代码块。这意味着你可以将文档和代码紧密结合,支持多种编程语言,使得代码文档化和执行变得更加简单和直观。
功能亮点
- 直接执行代码块:你可以在 Markdown 文件中编写代码,并使用 mdx 直接执行这些代码块。
- 支持多种编程语言:mdx 支持多种编程语言,让你可以在文档中使用不同的代码块。
- 参数传递:你可以向代码块传递参数,使得代码块更加灵活。
- 依赖定义:你可以在 Markdown 文件中定义代码块的依赖关系。
- 支持 shebang:mdx 支持在代码块中使用 shebang,使得代码块更加符合 Unix 哲学。
- 解析所有 Markdown 文件:mdx 会解析当前工作目录下的所有
.md
文件,寻找潜在的命令。 - 命令列表:使用
-list
或-l
参数,你可以列出所有可用的命令。
使用示例
假设你有一个名为 demo.md
的 Markdown 文件,内容如下:
markdown
# demo.md
## [simple_echo]() - Simple echo in shell
```sh
echo "hello world"
使用 mdx 执行其中的 shell 代码块:
```bash
mdx simple_echo
hello world
安装指南
直接下载
你可以从 mdx 的 GitHub Releases 页面 下载适合你的操作系统和架构的二进制文件。
从源代码构建
如果你更喜欢从源代码构建 mdx,你需要确保你的系统上安装了 Go 语言环境。按照以下步骤操作:
- 克隆 mdx 的 GitHub 仓库:
bash
git clone https://github.com/dim0x69/mdx
- 构建 mdx:
bash
go build
- 安装 mdx:
bash
go install
结语
mdx 是一个非常实用的工具,它让 Markdown 文件不仅仅是静态文档,而是可以包含可执行代码的动态文档。无论是个人项目还是团队协作,mdx 都能大大提高你的工作效率。快去试试吧!