GitHub-Markdown-Toc：轻松为GitHub Readme.md创建目录

GitHub-Markdown-Toc 是一个非常实用的工具，它能够自动为 Markdown 文件生成目录。这对于在 GitHub 上编写技术文档和博客来说非常方便。在使用之前，你需要先安装它。下面是安装和使用 GitHub-Markdown-Toc 的步骤：

1. 安装：你可以通过 npm 来安装这个工具。打开终端并输入以下命令：

   npm install --save-dev github-markdown-toc

2. 使用：安装完成后，你可以在任何 Markdown 文件中使用这个工具。你只需要在文件顶部添加一行特殊的代码，如下所示：

   <!-- toc -->
   <!-- /toc -->

   然后，在你想要添加目录的地方运行以下命令：

   npm run toc

   这将在你的 Markdown 文件中生成一个目录。你可以根据需要调整目录的样式和格式。
3. 定制：如果你想定制目录的样式，你可以在项目的根目录下创建一个名为 .github-markdown-toc 的文件。在这个文件中，你可以设置各种选项，例如目录的位置、对齐方式、缩进等。具体设置方式可以参考 GitHub-Markdown-Toc 的官方文档。
4. 注意事项：在使用这个工具时，请确保你的 Markdown 文件已经保存，否则生成的目录可能不会更新。另外，如果你在编辑过程中删除了原有的目录，你需要重新运行 npm run toc 命令来重新生成目录。
   GitHub-Markdown-Toc 的使用非常简单，只需要按照以上步骤操作即可。这个工具不仅适用于个人项目，也适用于开源项目的文档编写。它能够大大提高你的写作效率，让你的技术文档更加清晰易懂。希望本文对你有所帮助！如果你有任何问题或建议，请随时在评论区留言。