Skip to content

Commit 99148d1

Browse files
docs(readme): Add Table of Contents (#66)
* chore: Add Doctoc dependency * docs(readme): Add Table of Contents
1 parent 4bc6ba1 commit 99148d1

File tree

3 files changed

+249
-9
lines changed

3 files changed

+249
-9
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,26 @@
66

77
`create-instantsearch-app` is a command line utility that helps you quick start your InstantSearch app using any [Algolia][algolia-website] InstantSearch flavor ([InstantSearch.js][instantsearchjs-github], [React InstantSearch][react-instantsearch-github], [Vue InstantSearch][vue-instantsearch-github] and [Angular InstantSearch][angular-instantsearch-github]).
88

9+
<details>
10+
<summary><strong>Table of contents</strong></summary>
11+
12+
13+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
14+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
15+
16+
17+
- [Get started](#get-started)
18+
- [Usage](#usage)
19+
- [API](#api)
20+
- [Lifecycle](#lifecycle)
21+
- [Templates](#templates)
22+
- [Previews](#previews)
23+
- [License](#license)
24+
25+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
26+
27+
</details>
28+
929
## Get started
1030

1131
> The tool requires Node ≥ 8.
@@ -55,8 +75,6 @@ $ create-instantsearch-app --help
5575
-h, --help output usage information
5676
```
5777

58-
### Options documentation
59-
6078
#### `--template`
6179

6280
Supported templates are:
@@ -67,6 +85,10 @@ Supported templates are:
6785
- [`Vue InstantSearch`][vue-instantsearch-github]
6886
- [`Angular InstantSearch`][angular-instantsearch-github]
6987

88+
```
89+
create-instantsearch-app my-app --template "React InstantSearch"
90+
```
91+
7092
You can also [create your own template](#templates) and specify its path.
7193

7294
#### `--config`

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"lint": "eslint .",
1818
"lint:fix": "yarn lint --fix",
1919
"format": "prettier --write *.{js,md,json}",
20+
"doctoc": "doctoc --maxlevel 3 README.md",
2021
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
2122
"release-templates": "node ./scripts/release-templates",
2223
"release": "release-it",
@@ -47,6 +48,7 @@
4748
"devDependencies": {
4849
"babel-eslint": "8.2.3",
4950
"conventional-changelog-cli": "2.0.1",
51+
"doctoc": "1.3.1",
5052
"eslint": "4.19.1",
5153
"eslint-config-algolia": "13.1.0",
5254
"eslint-config-prettier": "2.9.0",

0 commit comments

Comments
 (0)