0f2715bb45ef025b48469817712a4cd3e23839b6

Message

docs: add Table of Contents to README (#10766)

Co-authored-by: Mohan Sha <mohansha@outlook.com>

Diff

This diff is truncated to protect this page.

  1diff --git a/README.md b/README.md
  2index 5a6b9844374446297c84493c21f98820a41d7519..4c41fad8163b4b0511c6165997dbea60431270bb 100644
  3--- a/README.md
  4+++ b/README.md
  5@@ -18,6 +18,41 @@ To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twi
  6 [![Gitpod ready](https://img.shields.io/badge/Gitpod-ready-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ohmyzsh/ohmyzsh)
  7 [![huntr.dev](https://cdn.huntr.dev/huntr_security_badge_mono.svg)](https://huntr.dev/bounties/disclose/?utm_campaign=ohmyzsh%2Fohmyzsh&utm_medium=social&utm_source=github&target=https%3A%2F%2Fgithub.com%2Fohmyzsh%2Fohmyzsh)
  8 
  9+<details>
 10+<summary>Table of Contents</summary>
 11+
 12+- [Getting Started](#getting-started)
 13+  - [Prerequisites](#prerequisites)
 14+  - [Basic Installation](#basic-installation)
 15+    - [Manual inspection](#manual-inspection)
 16+- [Using Oh My Zsh](#using-oh-my-zsh)
 17+  - [Plugins](#plugins)
 18+    - [Enabling Plugins](#enabling-plugins)
 19+    - [Using Plugins](#using-plugins)
 20+  - [Themes](#themes)
 21+    - [Selecting a Theme](#selecting-a-theme)
 22+  - [FAQ](#faq)
 23+- [Advanced Topics](#advanced-topics)
 24+  - [Advanced Installation](#advanced-installation)
 25+    - [Custom Directory](#custom-directory)
 26+    - [Unattended install](#unattended-install)
 27+    - [Installing from a forked repository](#installing-from-a-forked-repository)
 28+    - [Manual Installation](#manual-installation)
 29+  - [Installation Problems](#installation-problems)
 30+  - [Custom Plugins and Themes](#custom-plugins-and-themes)
 31+- [Getting Updates](#getting-updates)
 32+  - [Manual Updates](#manual-updates)
 33+- [Uninstalling Oh My Zsh](#uninstalling-oh-my-zsh)
 34+- [How do I contribute to Oh My Zsh?](#how-do-i-contribute-to-oh-my-zsh)
 35+  - [Do NOT send us themes](#do-not-send-us-themes)
 36+- [Contributors](#contributors)
 37+- [Follow Us](#follow-us)
 38+- [Merchandise](#merchandise)
 39+- [License](#license)
 40+- [About Planet Argon](#about-planet-argon)
 41+
 42+</details>
 43+
 44 ## Getting Started
 45 
 46 ### Prerequisites
 47@@ -32,7 +67,7 @@ To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twi
 48 Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either `curl`, `wget` or another similar tool.
 49 
 50 | Method    | Command                                                                                           |
 51-|:----------|:--------------------------------------------------------------------------------------------------|
 52+| :-------- | :------------------------------------------------------------------------------------------------ |
 53 | **curl**  | `sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` |
 54 | **wget**  | `sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"`   |
 55 | **fetch** | `sh -c "$(fetch -o - https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` |
 56@@ -82,7 +117,7 @@ _Note that the plugins are separated by whitespace (spaces, tabs, new lines...).
 57 
 58 #### Using Plugins
 59 
 60-Each plugin includes a __README__, documenting it. This README should show the aliases (if the plugin adds any) and extra goodies that are included in that particular plugin.
 61+Each plugin includes a **README**, documenting it. This README should show the aliases (if the plugin adds any) and extra goodies that are included in that particular plugin.
 62 
 63 ### Themes
 64 
 65@@ -194,19 +229,19 @@ REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh
 66 
 67 #### Manual Installation
 68 
 69-##### 1. Clone the repository
 70+##### 1. Clone the repository <!-- omit in toc -->
 71 
 72 ```sh
 73 git clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh
 74 ```
 75 
 76-##### 2. *Optionally*, backup your existing `~/.zshrc` file
 77+##### 2. _Optionally_, backup your existing `~/.zshrc` file <!-- omit in toc -->
 78 
 79 ```sh
 80 cp ~/.zshrc ~/.zshrc.orig
 81 ```
 82 
 83-##### 3. Create a new zsh configuration file
 84+##### 3. Create a new zsh configuration file <!-- omit in toc -->
 85 
 86 You can create a new zsh config file by copying the template that we have included for you.
 87 
 88@@ -214,7 +249,7 @@ You can create a new zsh config file by copying the template that we have includ
 89 cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc
 90 ```
 91 
 92-##### 4. Change your default shell
 93+##### 4. Change your default shell <!-- omit in toc -->
 94 
 95 ```sh
 96 chsh -s $(which zsh)
 97@@ -222,7 +257,7 @@ chsh -s $(which zsh)
 98 
 99 You must log out from your user session and log back in to see this change.
100 
101-##### 5. Initialize your new zsh configuration
102+##### 5. Initialize your new zsh configuration <!-- omit in toc -->
103 
104 Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.