Skip to content

Commit d5dd01e

Browse files
committed
doc: add table of contents and update benchmark link
1 parent b690d55 commit d5dd01e

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,32 @@
22

33
JavaScript library for creating CSS selectors for a given DOM element or multiple DOM elements.
44

5-
It also generates shorter selectors and is faster and/or more robust than many other libraries - see this [comparison](https://github.com/fczbkk/css-selector-generator-benchmark) and select the best alternative for your use case.
5+
See the [benchmark](https://fczbkk.github.io/css-selector-generator-benchmark/) to compare the speed and features of CSS Selector Generator with similar libraries.
6+
7+
## Table of Contents
8+
9+
- [Install](#install)
10+
- [How to use](#how-to-use)
11+
- [Usage without NPM](#usage-without-npm)
12+
- [Usage with virtual DOM (e.g. JSDOM)](#usage-with-virtual-dom-eg-jsdom)
13+
- [Shadow DOM](#shadow-dom)
14+
- [TypeScript](#typescript)
15+
- [Multi-element selector](#multi-element-selector)
16+
- [Fallback](#fallback)
17+
- [Options](#options)
18+
- [Selector types](#selector-types)
19+
- [Root element](#root-element)
20+
- [Blacklist](#blacklist)
21+
- [Whitelist](#whitelist)
22+
- [Combine within selector](#combine-within-selector)
23+
- [Combine between selectors](#combine-between-selectors)
24+
- [Include tag](#include-tag)
25+
- [Max combinations](#max-combinations)
26+
- [Max candidates](#max-candidates)
27+
- [Max results](#max-results)
28+
- [Use scope](#use-scope)
29+
- [Bug reports, feature requests and contact](#bug-reports-feature-requests-and-contact)
30+
- [License](#license)
631

732
## Install
833

0 commit comments

Comments
 (0)