0. 概述

作为一个好的 Github 项目，README 的质量是很重要的，其中 TOC 我觉得是一个很重要的东西，这里我就介绍一下我是如何创建 README 的 TOC 的。

更新 @ 2023-02-03

现在，Github 已经官方支持 TOC 了，所以本文的信息已经过期了。

Github 官方支持的 TOC

1. Readme 创建 TOC

虽然很多 Markdown 编辑器都是支持生成 TOC 的，但是，我试过几款常用的都不支持 Github 的 TOC，而且我常用开发环境是 Linux，所以就考虑 CMD 下的选择，然后发现了一款不错的工具：，安装也很简单：

  1. [root@liqiang.io]# wget https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
  2. [root@liqiang.io]# chmod a+x gh-md-toc

然后用的时候直接通过 gh-md-toc README.md 即可生成 TOC 了：

  1. [root@liqiang.io]# gh-md-toc README.md
  2. Table of Contents
  3. =================
  5.    * [Introduction](#introduction)
  6.    * [Features](#features)
  7.    * [Installation](#installation)
  8.    * [Docker-compose demo](#docker-compose-demo)
  9.    * [Running demo locally without Docker](#running-demo-locally-without-docker)
  10.    * [Configuration and Usage](#configuration-and-usage)
  11.          * [Multiple node support](#multiple-node-support)
  13. Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)

2. Ref