Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: remove table of contents from markdown text #15999

Merged
merged 2 commits into from Jun 21, 2022
Merged

docs: remove table of contents from markdown text #15999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae57021
docs: remove table of contents from markdown text
snitin315 Jun 14, 2022
1b207e3
docs: remove TOC from nodejs-api
snitin315 Jun 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 0 additions & 33 deletions docs/src/developer-guide/nodejs-api.md
View file
Open in desktop
Expand Up @@ -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.
Expand Down
8 changes: 0 additions & 8 deletions docs/src/user-guide/configuring/configuration-files.md
View file
Open in desktop
Expand Up @@ -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:
Expand Down
6 changes: 0 additions & 6 deletions docs/src/user-guide/configuring/ignoring-code.md
View file
Open in desktop
Expand Up @@ -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.
Expand Down
4 changes: 0 additions & 4 deletions docs/src/user-guide/configuring/language-options.md
View file
Open in desktop
Expand Up @@ -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:
Expand Down
4 changes: 0 additions & 4 deletions docs/src/user-guide/configuring/plugins.md
View file
Open in desktop
Expand Up @@ -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:
Expand Down
3 changes: 0 additions & 3 deletions docs/src/user-guide/configuring/rules.md
View file
Open in desktop
Expand Up @@ -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:
Expand Down