Skip to content

Commit 1836b6b

Browse files
committed
docs(README): add TOC
1 parent fe7cbea commit 1836b6b

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,20 @@
55
[![License][license-image]][license-url] [![Readme Score][readme-score-img]][readme-score-url] [![Inline docs][inch-ci-img]][inch-ci-url] [![Build Status][travis-ci-img]][travis-ci-url] [![Codacy Badge][codacy-img]][codacy-url] [![Coverage Status][coveralls-img]][coveralls-url]<br>
66
[![NSP Status][nsp-img]][nsp-url] [![bitHound Dependencies][bithound-dep-img]][bithound-dep-url] [![bitHound Dev Dependencies][bithound-dev-dep-img]][bithound-dev-dep-url]
77

8-
## Table of contents
9-
8+
## 1. Table of contents
109
<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
1110

12-
- [Table of contents](#table-of-contents)
13-
- [Installation](#installation)
14-
- [Usage](#usage)
15-
- [Supported rules](#supported-rules)
16-
- [Rules in backlog](#rules-in-backlog)
17-
- [Contributions](#contributions)
18-
- [License](#license)
11+
- [1. Table of contents](#1-table-of-contents)
12+
- [2. Installation](#2-installation)
13+
- [3. Usage](#3-usage)
14+
- [4. Supported rules](#4-supported-rules)
15+
- [5. Rules in backlog](#5-rules-in-backlog)
16+
- [6. Contributions](#6-contributions)
17+
- [7. License](#7-license)
1918

2019
<!-- /TOC -->
2120

22-
## Installation
21+
## 2. Installation
2322

2423
You'll first need to install [`ESLint`](http://eslint.org):
2524

@@ -39,7 +38,7 @@ $ npm install eslint-plugin-swagger --save-dev
3938

4039
**Note:** If you installed `ESLint` globally (using the `-g` flag) then you must also install `eslint-plugin-swagger` globally.
4140

42-
## Usage
41+
## 3. Usage
4342

4443
> #### :information_source: Swagger file extensions
4544
> `eslint-plugin-swagger` evaluates Swagger files that have a `.json`, `.yaml`, or `.yml` file extension.
@@ -76,7 +75,7 @@ Finally, run `ESLint` against your Swagger documents.
7675
$ eslint path/to/swagger/docs/** --fix
7776
```
7877

79-
## Supported rules
78+
## 4. Supported rules
8079

8180
> ###### `options` legend
8281
>
@@ -89,7 +88,7 @@ $ eslint path/to/swagger/docs/** --fix
8988
| | [`no-path-verbs`][no-path-verbs-url] | Prohibit verbs in api paths | Completed |
9089
| :wrench: | [`require-plural-paths`][rule-plural-paths-url] | Require plural nouns in API paths | Completed |
9190

92-
## Rules in backlog
91+
## 5. Rules in backlog
9392

9493
The product backlog has lots of lonely `rules` looking for love from nice contributors like you. :kissing_heart: If you're interested, please:
9594

@@ -124,15 +123,15 @@ The product backlog has lots of lonely `rules` looking for love from nice contri
124123
| | [`require-default-value`](https://github.com/gregswindle/eslint-plugin-swagger/issues/new?title=feat%28require-default-value%29%3A%20Every%20place%20where%20a%20default...&labels[]=ESLint%3A%20Rule&labels[]=Status%3A%20Available&labels[]=Type%3A%20Feature&labels[]=Type%3A%20Docs) | Every place where a default value can be provided, the default value must validate against the corresponding schema/definition. _(This is not handled by JSON Schema validators, at least not the one I am using, so we have to do this manually. See [json-schema/JSON-Schema-Test-Suite/pull/67](https://github.com/json-schema/JSON-Schema-Test-Suite/pull/67))_ | Available |
125124
| | [`require-path-definition`](https://github.com/gregswindle/eslint-plugin-swagger/issues/new?title=feat%28require-path-definition%29%3A%20For%20each%20API%20path%20parameter...&labels[]=ESLint%3A%20Rule&labels[]=Status%3A%20Available&labels[]=Type%3A%20Feature&labels[]=Type%3A%20Docs) | For each API path parameter, all operations for the API path require corresponding path parameter definitions or the corresponding path parameter needs to be in the path's parameters. | Available |
126125

127-
## Contributions
126+
## 6. Contributions
128127
:family: We warmly welcome contributors. Check out the guidelines for [Contributing to `eslint-plugin-swagger`](./.github/CONTRIBUTING.md) and our [Contributor Covenant Code of Conduct][code-of-conduct-url].
129128

130129
Contributions are stories with a beginning, a middle, and an end, all told through issues and pull requests.
131130
* [Peruse open issues][issues-url] or
132131
* [View rules in the backlog][rules-backlog-wiki-url]
133132
* [Open a new pull request (PR)][pr-url]
134133

135-
## License
134+
## 7. License
136135

137136
[Apache 2.0][license-url] :copyright: [Greg Swindle][author-url].
138137

0 commit comments

Comments
 (0)