什么是标记目录生成器?
Markdown目录生成器读取Markdown文档中的标题,并生成一个嵌套的链接列表,这些链接跳转到每个部分。您粘贴您的Markdown,工具返回一个即用型块,例如项目符号列表,其中每行都是`[标题](#anchor)`链接。它可以节省您手写大纲和猜测渲染器将分配给每个标题的锚id。
器(tool)的核心是锚点slug。github、gitlab和大多数静态站点生成器通过将文本降壳、删除标点符号和用连字符替换空格,将像入门这样的标题变成id`入门`。这个生成器应用了相同的规则,包括当两个标题共享一个slug时github添加的数字后缀(`-1`、`-2`),因此它产生的链接解析到你的readme或docs页面将呈现的确切id。它读取了atx标题(以`#`开头的行)和setext标题(用`=`或`-`划线的文本),并且它忽略了出现在有围栏代码块内的任何`#`。承载内联格式的标题处理方式相同:链接、粗体文本、内联代码或标题内的图像被简化为标签的纯文本,并且锚点是由同一个清理过的字符串构建的,因此两者始终一致。
Everything都在你的浏览器中运行你粘贴的Markdown是用客户端JavaScript解析的,永远不会离开你的设备,所以没有上传,没有帐户,也没有跟踪你的内容,一旦页面加载,该工具就会离线工作,让你选择要包含的标题级别,在项目符号和编号列表之间切换,并控制缩进,它会在你更改选项的那一刻更新轮廓。
如何使用 Markdown TOC 生成器?
粘贴您的Markdown
Markdown 完整文档或 README 放入输入框中, 自动跳过围栏代码块内的标题。
选择标题级别
设置要包含的最浅和最深的级别。常见的选择是 H2 到 H3,它可以保持轮廓的可读性,而无需列出每个小节。
选择列表样式
在项目符号或编号列表之间切换,打开或关闭锚链路,然后选择两个空格、四个空格或选项卡缩进。
复制目录
Markdown 复制生成的,贴在文档顶部附近,每个条目链接到匹配的标题锚。
主要特点
GitHub 兼容锚
Slugs匹配ids GitHub渲染,包括重复标题的数字后缀,因此每个链接都正确解析。
液位过滤
仅包括您想要的航向级别。嵌套是从最浅的包含航向测量的,因此从 H2 开始的列表保持左齐平。
有序或无序
输出带有每级计数器的项目符号列表或编号列表,并具有可选的锚链接和可配置的缩进。
代码块感知
写在围栏代码块内的标题将被忽略,因此示例片段永远不会泄漏到您的轮廓中。
Frequently Asked Questions
Related Tools
HTML Table Generator
Generate an accessible HTML table from pasted CSV or tab-separated data. Add a header row, caption, striped rows, and borders, then copy the HTML and CSS. Runs client-side.
HTML to Markdown
Convert HTML to clean Markdown instantly. Turns headings, lists, links, images, blockquotes, code blocks and tables into portable GitHub Flavored Markdown. Tolerant of messy CMS markup. Runs client-side.
Markdown to HTML
Convert Markdown to clean, semantic HTML with GitHub Flavored Markdown support - tables, task lists, fenced code, heading anchors, live preview and a full HTML document export.
WordPress Readme Generator
Write a plugin readme.txt the WordPress.org directory parses, with a live preview of the listing it produces and a download when it is right.
Comments
0 comments
No comments yet. Be the first to share your thoughts!