Skip to content

Commit 08370e4

Browse files
docs(readme): add table of contents to README
https://jsfiddle.net/remarkablemark/o0mja3hf/
1 parent bbd8cf6 commit 08370e4

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,37 @@ parse('<div>text</div>'); // equivalent to `React.createElement('div', {}, 'text
2626

2727
[CodeSandbox](https://codesandbox.io/s/940pov1l4w) | [Repl.it](https://repl.it/@remarkablemark/html-react-parser) | [JSFiddle](https://jsfiddle.net/remarkablemark/7v86d800/) | [Examples](https://github.com/remarkablemark/html-react-parser/tree/master/examples)
2828

29+
<details>
30+
<summary>Table of Contents</summary>
31+
32+
- [Install](#install)
33+
- [Usage](#usage)
34+
- [Options](#options)
35+
- [replace(domNode)](#replacedomnode)
36+
- [library](#library)
37+
- [htmlparser2](#htmlparser2)
38+
- [trim](#trim)
39+
- [FAQ](#faq)
40+
- [Is this XSS safe?](#is-this-xss-safe)
41+
- [Does invalid HTML get sanitized?](#does-invalid-html-get-sanitized)
42+
- [Are `<script>` tags parsed?](#are-script-tags-parsed)
43+
- [Attributes aren't getting called](#attributes-arent-getting-called)
44+
- [Parser throws an error](#parser-throws-an-error)
45+
- [Is SSR supported?](#is-ssr-supported)
46+
- [Elements aren't nested correctly](#elements-arent-nested-correctly)
47+
- [Warning: validateDOMNesting(...): Whitespace text nodes cannot appear as a child of table](#warning-validatedomnesting-whitespace-text-nodes-cannot-appear-as-a-child-of-table)
48+
- [Don't change case of tags](#dont-change-case-of-tags)
49+
- [Benchmarks](#benchmarks)
50+
- [Contributors](#contributors)
51+
- [Code Contributors](#code-contributors)
52+
- [Financial Contributors](#financial-contributors)
53+
- [Individuals](#individuals)
54+
- [Organizations](#organizations)
55+
- [Support](#support)
56+
- [License](#license)
57+
58+
</details>
59+
2960
## Install
3061

3162
[NPM](https://www.npmjs.com/package/html-react-parser):

0 commit comments

Comments
 (0)