☰ 菜单
首页›命令行工具›markdown-toc
命令行 开源 6 次安装/月

markdown-toc for Mac 版

markdown-toc

使用 Remarkable 生成 markdown 目录(TOC)

markdown-toc 是什么

markdown-toc 是一个用来为 Markdown 文档生成目录(TOC)的工具,基于 Remarkable 解析器实现。它能自动扫描文档中的标题层级,生成结构清晰的目录,并支持通过命令行直接插入到 README 等文件中。

核心功能包括:可作为 Remarkable 插件使用;返回渲染好的目录内容以及原始 JSON 结构,方便自定义模板输出;支持重复标题;提供合理默认值,无需配置即可上手;允许过滤不需要的标题、调整标题文本、自定义 slugify 函数来控制链接生成方式。它还特别处理了代码块中的 `#` 注释和 front-matter,避免把它们误判为标题——这是不少同类工具容易出错的地方。

这个工具适合需要维护长 Markdown 文档的开发者,尤其是经常写 README、技术文档或静态站点内容的人。通过 CLI 一条命令就能把目录写入文件,也可以集成到构建流程中按需生成。

如何安装 markdown-toc

  1. 打开 终端(按 ⌘ + 空格,输入“终端”)。
  2. 如果还没安装 Homebrew,先运行下面这条安装命令。
  3. 运行下面这条命令:

最近 10 个版本记录

该项目暂未在 GitHub 发布 Release。

二进制包支持平台

Homebrew 官方提供的预编译包(bottle)覆盖:

  • all

⚠️ 未提供 Intel Mac 的预编译包,Intel 机型需要通过 brew install --build-from-source 从源码编译。

与同类应用对比

只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。

与同类应用对比
应用版本许可证架构近 30 天安装
markdown-toc1.2.0MIT命令行6
discount3.0.2.0BSD-3-Clause命令行10
madov0.4.0Apache-2.0命令行30
gotestsv1.9.0Apache-2.0命令行13

命令行工具中的类似应用

发表评论

电子邮件地址不会被公开。必填项已用 * 标注。