0. 概述

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

1. Readme 创建 TOC

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

[[email protected]]# wget https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
[[email protected]]# chmod a+x gh-md-toc

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

[[email protected]]# gh-md-toc README.md
Table of Contents
=================

   * [Introduction](#introduction)
   * [Features](#features)
   * [Installation](#installation)
   * [Docker-compose demo](#docker-compose-demo)
   * [Running demo locally without Docker](#running-demo-locally-without-docker)
   * [Configuration and Usage](#configuration-and-usage)
         * [Multiple node support](#multiple-node-support)

Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)

2. Ref