Merge pull request #604 from peco/remove-toc

We don't need a TOC in the age of AIs

.github/workflows/toc.yml

@@ -1,27 +0,0 @@
-name: Generate Table of Contents
-
-on:
-  push:
-    branches:
-      - master
-    paths:
-      - 'README.md'
-
-jobs:
-  generateTOC:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-        with:
-          ssh-key: ${{ secrets.DEPLOY_KEY }}
-      - run: sudo npm i --global doctoc
-      - run: doctoc --all --notitle README.md
-      - name: setup git user
-        run: |
-          git config --global user.name "${{ github.actor }}"
-          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
-      - run: |
-          git add .
-          git commit -m "docs: update toc" || true
-          git push

README.md

@@ -4,8 +4,6 @@ Simplistic interactive filtering tool
 
 *NOTE*: If you are viewing this on GitHub, this document refers to the state of `peco` in whatever current branch you are viewing, _not_ necessarily the state of a currently released version. Please make sure to checkout the [Changes](./Changes) file for features and changes.
 
-This README is long and comprehensive. Use the [Table of Contents](#table-of-contents) to navigate to the section that interests you. It has been placed at the bottom of the README file because of its length.
-
 > If you use peco, please consider sponsoring the authors of this project from the "Sponsor" button on the project page at https://github.com/peco/peco. Sponsorship plans start at $1 :)
 
 # Description
@@ -997,92 +995,3 @@ Unit test it.
 Obviously, kudos to the original percol: https://github.com/mooz/percol
 Much code stolen from https://github.com/mattn/gof
 
-# Table of Contents
-
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-- [peco](#peco)
-- [Description](#description)
-  - [Demo](#demo)
-- [Features](#features)
-  - [Incremental Search](#incremental-search)
-  - [Negative Matching](#negative-matching)
-  - [Select Multiple Lines](#select-multiple-lines)
-  - [Select Range Of Lines](#select-range-of-lines)
-  - [Select Filters](#select-filters)
-  - [Multi-Stage Filtering (Freeze Results)](#multi-stage-filtering-freeze-results)
-  - [Horizontal Scrolling](#horizontal-scrolling)
-  - [ANSI Color Support](#ansi-color-support)
-  - [Context Lines (Zoom In/Out)](#context-lines-zoom-inout)
-  - [Selectable Layout](#selectable-layout)
-  - [Inline Mode (--height)](#inline-mode---height)
-  - [Works on Windows!](#works-on-windows)
-- [Installation](#installation)
-    - [Just want the binary?](#just-want-the-binary)
-    - [macOS (Homebrew, Scarf)](#macos-homebrew-scarf)
-    - [Debian and Ubuntu based distributions (APT, Scarf)](#debian-and-ubuntu-based-distributions-apt-scarf)
-    - [Void Linux (XBPS)](#void-linux-xbps)
-    - [Arch Linux](#arch-linux)
-    - [Windows (Chocolatey NuGet Users)](#windows-chocolatey-nuget-users)
-    - [Building peco yourself](#building-peco-yourself)
-    - [go get IS NOT RECOMMENDED](#go-get-is-not-recommended)
-- [Command Line Options](#command-line-options)
-    - [-h, --help](#-h---help)
-    - [--version](#--version)
-    - [--query <query>](#--query-query)
-    - [--print-query](#--print-query)
-    - [--rcfile <filename>](#--rcfile-filename)
-    - [-b, --buffer-size <num>](#-b---buffer-size-num)
-    - [--null](#--null)
-    - [--initial-index](#--initial-index)
-    - [--initial-filter `IgnoreCase|CaseSensitive|SmartCase|IRegexp|Regexp|Fuzzy`](#--initial-filter-ignorecasecasesensitivesmartcaseiregexpregexpfuzzy)
-    - [--prompt](#--prompt)
-    - [--layout `top-down|bottom-up`](#--layout-top-downbottom-up)
-    - [--select-1](#--select-1)
-    - [--on-cancel `success|error`](#--on-cancel-successerror)
-    - [--selection-prefix `string`](#--selection-prefix-string)
-    - [--exec `string`](#--exec-string)
-    - [--ansi](#--ansi)
-    - [--height `num|percentage`](#--height-numpercentage)
-- [Configuration File](#configuration-file)
-  - [Global](#global)
-    - [Prompt](#prompt)
-    - [InitialMatcher](#initialmatcher)
-    - [InitialFilter](#initialfilter)
-    - [FuzzyLongestSort](#fuzzylongestsort)
-    - [StickySelection](#stickyselection)
-    - [SuppressStatusMsg](#suppressstatusmsg)
-    - [OnCancel](#oncancel)
-    - [MaxScanBufferSize](#maxscanbuffersize)
-    - [ANSI](#ansi)
-    - [Height](#height)
-  - [Keymaps](#keymaps)
-    - [Key sequences](#key-sequences)
-    - [Combined actions](#combined-actions)
-    - [Available keys](#available-keys)
-    - [Key workarounds](#key-workarounds)
-    - [Available actions](#available-actions)
-    - [Default Keymap](#default-keymap)
-  - [Styles](#styles)
-    - [Foreground Colors](#foreground-colors)
-    - [Background Colors](#background-colors)
-    - [Attributes](#attributes)
-  - [CustomFilter](#customfilter)
-    - [Examples](#examples)
-  - [Layout](#layout)
-  - [SingleKeyJump](#singlekeyjump)
-  - [SelectionPrefix](#selectionprefix)
-  - [Use256Color](#use256color)
-- [FAQ](#faq)
-  - [Does peco work on (msys2|cygwin)?](#does-peco-work-on-msys2cygwin)
-  - [Non-latin fonts (e.g. Japanese) look weird on my Windows machine...?](#non-latin-fonts-eg-japanese-look-weird-on-my-windows-machine)
-  - [Seeing escape sequences `[200~` and `[201~` when pasting text?](#seeing-escape-sequences-200-and-201-when-pasting-text)
-- [Hacking](#hacking)
-- [TODO](#todo)
-- [AUTHORS](#authors)
-- [CONTRIBUTORS](#contributors)
-- [Notes](#notes)
-- [Table of Contents](#table-of-contents)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->