MDUtil

Markdown 目录生成器

粘贴 README 或任意 Markdown 文档,得到可以在 GitHub、GitLab 和 VS Code 里点击跳转的目录,内容不会上传。

Markdown

132 个字符25 行
- [快速上手](#快速上手)
  - [安装](#安装)
  - [首次运行](#首次运行)
- [配置](#配置)
  - [同步与存储](#同步与存储)
  - [照片](#照片)
- [常见问题](#常见问题)
- [用法](#用法)
- [用法](#用法-1)

能处理什么

GitHub 的锚点
链接使用 GitHub 生成的锚点:字母转小写,空格变成连字符,去掉标点,重复的标题加上 -1、-2。
任意级别范围
可以只列出 ## 和 ###,也可以选择 1 到 6 级之间的任意范围,层级跟随标题级别。
原地更新
在文件里放上 <!-- toc --> 和 <!-- tocstop -->,每次都会把目录写在两者之间。
忽略代码
代码块里以 # 开头的行不会被当成标题。
链接文字干净
标题里的加粗、代码和链接在目录中都变成普通文字。
中文和日文标题
中日文标题在锚点里保留原来的文字,和 GitHub 一致。

GitHub 如何生成标题锚点

GitHub 会根据标题文字为每个标题生成锚点:字母转成小写,空格变成连字符,标点被去掉。重复的标题依次加上 -1、-2。

标题链接
## Getting Started#getting-started
## 同步 & 存储#同步--存储
## 安装#安装
第二个 ## 用法#用法-1

用锚点链接到标题,例如 [安装](#安装)。GitLab 和 VS Code 生成锚点的方式与 GitHub 相同。

常见问题

怎么给 Markdown 文件加目录?

把文件粘贴到上面,复制目录放进文件里;或者在需要的位置放上 <!-- toc --> 和 <!-- tocstop -->,再从第二个标签页复制整篇文档。

GitHub 会自动生成目录吗?

GitHub 在文件上方的大纲按钮里显示 README 的标题大纲,但不会把目录写进文件。写在文件里的链接列表在其他网站、编辑器和导出的文档里也能使用。

Markdown 里怎么链接到某个标题?

使用标题的锚点:[安装](#安装)。锚点就是标题文字转成小写、空格换成连字符、去掉标点后的结果。

怎么让目录保持最新?

在文件里保留 <!-- toc --> 标记,修改后再粘贴到这里,标记之间的目录会被替换。在 VS Code 里,Markdown All in One 插件可以在保存时更新目录。

为什么点击链接跳不到标题?

不同网站生成锚点的方式不同。这里的链接遵循 GitHub、GitLab 和 VS Code 的规则;Bitbucket 会在前面加上 markdown-header-,部分网站生成器也有自己的规则。

文档会上传吗?

不会。目录在你的浏览器里生成,文档不会离开你的设备。