推荐使用 gh-md-toc：轻松生成 Markdown 文件的目录

推荐使用 gh-md-toc：轻松生成 Markdown 文件的目录

【免费下载链接】github-markdown-toc Easy TOC creation for GitHub README.md 项目地址: https://gitcode.com/gh_mirrors/gi/github-markdown-toc

项目介绍

gh-md-toc 是一个开源工具，旨在帮助用户为 Markdown 文件或 GitHub Wiki 页面生成目录（TOC，Table Of Content），而无需安装任何额外的软件。这个工具解决了 GitHub 上长期存在的问题，即无法直接在 Markdown 文件中生成目录。

项目技术分析

gh-md-toc 是一个基于 Bash 的脚本，支持处理以下类型的输入：

• 标准输入（stdin）：直接从命令行读取 Markdown 内容。
• 本地文件：处理本地文件系统中的 Markdown 文件。
• 远程文件：处理位于 GitHub 上的 Markdown 文件。

此外，gh-md-toc 还提供了自动插入和更新 TOC 的功能，使得维护文档更加便捷。

项目及技术应用场景

gh-md-toc 适用于以下场景：

• 文档编写：在编写大型 Markdown 文档时，生成目录可以显著提高文档的可读性和导航性。
• 项目维护：在维护 GitHub 项目时，自动更新 README.md 的目录可以节省大量时间。
• Wiki 管理：管理 GitHub Wiki 页面时，自动生成和更新目录可以提升 Wiki 的可访问性。

项目特点

• 无需安装额外软件：直接使用 Bash 脚本，无需安装任何依赖。
• 支持多种输入方式：无论是本地文件、远程文件还是标准输入，都能轻松处理。
• 自动插入和更新 TOC：通过简单的标记，可以自动插入和更新目录，极大提升文档维护效率。
• 跨平台支持：经过测试，gh-md-toc 在 Ubuntu 和 macOS 上运行良好。对于 Windows 用户，推荐使用基于 Go 语言的实现版本。

安装与使用

安装

Linux

$ wget https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
$ chmod a+x gh-md-toc

macOS

$ curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
$ chmod a+x gh-md-toc

使用

从标准输入生成 TOC

$ cat ~/projects/Dockerfile.vim/README.md | ./gh-md-toc -

处理本地文件

$ ./gh-md-toc ~/projects/Dockerfile.vim/README.md

处理远程文件

$ ./gh-md-toc https://github.com/ekalinin/envirius/blob/master/README.md

自动插入和更新 TOC

在文件中添加以下标记：

<!--ts-->
<!--te-->

然后运行：

$ ./gh-md-toc --insert README.md

结语

gh-md-toc 是一个简单而强大的工具，能够帮助你轻松管理 Markdown 文件的目录。无论是个人项目还是团队协作，gh-md-toc 都能显著提升文档的可读性和维护效率。快来尝试吧！

【免费下载链接】github-markdown-toc Easy TOC creation for GitHub README.md 项目地址: https://gitcode.com/gh_mirrors/gi/github-markdown-toc