From 6d0cb11c6d134896d8920c9bf3cc3e492f0eb8e2 Mon Sep 17 00:00:00 2001 From: Nitin Kumar Date: Tue, 21 Jun 2022 23:16:26 +0530 Subject: [PATCH] docs: remove table of contents from markdown text (#15999) * docs: remove table of contents from markdown text * docs: remove TOC from nodejs-api --- docs/src/developer-guide/nodejs-api.md | 33 ------------------- .../configuring/configuration-files.md | 8 ----- .../user-guide/configuring/ignoring-code.md | 6 ---- .../configuring/language-options.md | 4 --- docs/src/user-guide/configuring/plugins.md | 4 --- docs/src/user-guide/configuring/rules.md | 3 -- 6 files changed, 58 deletions(-) diff --git a/docs/src/developer-guide/nodejs-api.md b/docs/src/developer-guide/nodejs-api.md index 08d7a1442c9..cefd83a1470 100644 --- a/docs/src/developer-guide/nodejs-api.md +++ b/docs/src/developer-guide/nodejs-api.md @@ -14,39 +14,6 @@ While ESLint is designed to be run on the command line, it's possible to use ESL **Note:** Use undocumented parts of the API at your own risk. Only those parts that are specifically mentioned in this document are approved for use and will remain stable and reliable. Anything left undocumented is unstable and may change or be removed at any point. -## Table of Contents - -* [ESLint] - * [constructor()][eslint-constructor] - * [lintFiles()][eslint-lintfiles] - * [lintText()][eslint-linttext] - * [getRulesMetaForResults()][eslint-getrulesmetaforresults] - * [calculateConfigForFile()][eslint-calculateconfigforfile] - * [isPathIgnored()][eslint-ispathignored] - * [loadFormatter()][eslint-loadformatter] - * [static version][eslint-version] - * [static outputFixes()][eslint-outputfixes] - * [static getErrorResults()][eslint-geterrorresults] - * [LintResult type][lintresult] - * [LintMessage type][lintmessage] - * [SuppressedLintMessage type][suppressedlintmessage] - * [EditInfo type][editinfo] - * [LoadedFormatter type][loadedformatter] -* [SourceCode](#sourcecode) - * [splitLines()](#sourcecodesplitlines) -* [Linter](#linter) - * [verify()](#linterverify) - * [verifyAndFix()](#linterverifyandfix) - * [defineRule()](#linterdefinerule) - * [defineRules()](#linterdefinerules) - * [getRules()](#lintergetrules) - * [defineParser()](#linterdefineparser) - * [version](#linterversionlinterversion) -* [RuleTester](#ruletester) - * [Customizing RuleTester](#customizing-ruletester) - ---- - ## ESLint class The `ESLint` class is the primary class to use in Node.js applications. diff --git a/docs/src/user-guide/configuring/configuration-files.md b/docs/src/user-guide/configuring/configuration-files.md index 24a92bb1483..f048868c9ed 100644 --- a/docs/src/user-guide/configuring/configuration-files.md +++ b/docs/src/user-guide/configuring/configuration-files.md @@ -10,14 +10,6 @@ eleventyNavigation: --- -* [Configuration File Formats](#configuration-file-formats) -* [Using Configuration Files](#using-configuration-files) -* [Adding Shared Settings](#adding-shared-settings) -* [Cascading and Hierarchy](#cascading-and-hierarchy) -* [Extending Configuration Files](#extending-configuration-files) -* [Configuration Based on Glob Patterns](#configuration-based-on-glob-patterns) -* [Personal Configuration Files](#personal-configuration-files-deprecated) - ## Configuration File Formats ESLint supports configuration files in several formats: diff --git a/docs/src/user-guide/configuring/ignoring-code.md b/docs/src/user-guide/configuring/ignoring-code.md index db988459d5d..e267170d16d 100644 --- a/docs/src/user-guide/configuring/ignoring-code.md +++ b/docs/src/user-guide/configuring/ignoring-code.md @@ -10,12 +10,6 @@ eleventyNavigation: --- -* [`ignorePatterns` in Config Files](#ignorepatterns-in-config-files) -* [The `.eslintignore` File](#the-eslintignore-file) -* [Using an Alternate File](#using-an-alternate-file) -* [Using eslintIgnore in package.json](#using-eslintignore-in-packagejson) -* [Ignored File Warnings](#ignored-file-warnings) - ## `ignorePatterns` in Config Files You can tell ESLint to ignore specific files and directories using `ignorePatterns` in your config files. `ignorePatterns` patterns follow the same rules as `.eslintignore`. Please see the [the `.eslintignore` file documentation](./ignoring-code#the-eslintignore-file) to learn more. diff --git a/docs/src/user-guide/configuring/language-options.md b/docs/src/user-guide/configuring/language-options.md index 5397d8395e4..379c678f48c 100644 --- a/docs/src/user-guide/configuring/language-options.md +++ b/docs/src/user-guide/configuring/language-options.md @@ -10,10 +10,6 @@ eleventyNavigation: --- -* [Specifying Environments](#specifying-environments) -* [Specifying Globals](#specifying-globals) -* [Specifying Parser Options](#specifying-parser-options) - ## Specifying Environments An environment provides predefined global variables. The available environments are: diff --git a/docs/src/user-guide/configuring/plugins.md b/docs/src/user-guide/configuring/plugins.md index 6b0bb9b8592..3314ef9a130 100644 --- a/docs/src/user-guide/configuring/plugins.md +++ b/docs/src/user-guide/configuring/plugins.md @@ -10,10 +10,6 @@ eleventyNavigation: --- -* [Specifying Parser](#specifying-parser) -* [Specifying Processor](#specifying-processor) -* [Configuring Plugins](#configuring-plugins) - ## Specifying Parser By default, ESLint uses [Espree](https://github.com/eslint/espree) as its parser. You can optionally specify that a different parser should be used in your configuration file so long as the parser meets the following requirements: diff --git a/docs/src/user-guide/configuring/rules.md b/docs/src/user-guide/configuring/rules.md index 98b4645626c..ebc070f8cd7 100644 --- a/docs/src/user-guide/configuring/rules.md +++ b/docs/src/user-guide/configuring/rules.md @@ -10,9 +10,6 @@ eleventyNavigation: --- -* [Configuring Rules](#configuring-rules) -* [Disabling Rules](#disabling-rules) - ## Configuring Rules ESLint comes with a large number of built-in rules and you can add more rules through plugins. You can modify which rules your project uses either using configuration comments or configuration files. To change a rule setting, you must set the rule ID equal to one of these values: