Skip to content

Commit 2edb17c

Browse files
committed
Update TOC
1 parent e37a4ee commit 2edb17c

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,20 @@
1111
1212
## Table of Contents
1313

14-
- [Getting Started](#getting-started)
15-
- [Installation](#installation)
16-
- [Usage](#usage)
17-
- [Metadata](#metadata)
18-
- [API](#api)
19-
- [Comparison](#comparison)
20-
- [License](#license)
14+
* [Getting Started](#getting-started)
15+
* [Installation](#installation)
16+
* [Usage](#usage)
17+
* [Metadata](#metadata)
18+
* [Customization](#customization)
19+
+ [Basic Configuration](#basic-configuration)
20+
+ [Advanced Configuration](#advanced-configuration)
21+
* [Plugins](#plugins)
22+
+ [Core Plugins](#core-plugins)
23+
+ [Community Plugins](#community-plugins)
24+
+ [Write your own plugin](#write-your-own-plugin)
25+
* [API](#api)
26+
* [Comparison](#comparison)
27+
* [License](#license)
2128

2229
## Getting Started
2330

@@ -117,11 +124,11 @@ The configuration file will be resolved starting from the location of the file b
117124

118125
**Note:** Using a configuration file you need to explicitly add all the plugins that you want to use.
119126

120-
#### Basic Configuration
127+
### Basic Configuration
121128

122129
Declared an `array` of `rules`, specifying each rule as `string` name of the module to load.
123130

124-
##### JSON
131+
#### JSON
125132

126133
```json
127134
// .metascraperrc
@@ -139,7 +146,7 @@ Declared an `array` of `rules`, specifying each rule as `string` name of the mod
139146
}
140147
```
141148

142-
##### YAML
149+
#### YAML
143150

144151
```yaml
145152
# .metascraperrc
@@ -154,11 +161,11 @@ rules:
154161
- metascraper-url
155162
```
156163
157-
#### Advanced Configuration
164+
### Advanced Configuration
158165
159166
Additionally, you can pass specific configuration per module using a `object` declaration:
160167

161-
##### JSON
168+
#### JSON
162169

163170
```json
164171
// .metascraperrc
@@ -179,7 +186,7 @@ Additionally, you can pass specific configuration per module using a `object` de
179186
}
180187
```
181188

182-
##### YAML
189+
#### YAML
183190

184191
```yaml
185192
# .metascraperrc
@@ -200,7 +207,7 @@ rules:
200207

201208
?> Can't find a plugin that you want? Let's [open an issue](https://github.com/microlinkhq/metacraper/issues) to create it.
202209

203-
## Core Plugins
210+
### Core Plugins
204211

205212
These plugins will be shipped with **metascraper** and loaded by default.
206213

@@ -215,15 +222,15 @@ These plugins will be shipped with **metascraper** and loaded by default.
215222
| [`metascraper-title`](/packages/metascraper-title) | [![npm](https://img.shields.io/npm/v/metascraper-title.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-title) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-title&?style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-title) |
216223
| [`metascraper-url`](/packages/metascraper-url) | [![npm](https://img.shields.io/npm/v/metascraper-url.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-url) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-url&?style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-url) |
217224

218-
## Community Plugins
225+
### Community Plugins
219226

220227
These plugins will not be shipped with **metascraper** by default and need to be specific using a configuration file.
221228

222229
| Package | Version | Dependencies |
223230
|--------|-------|------------|
224231
| [`metascraper-clearbit-logo`](/packages/metascraper-clearbit-logo) | [![npm](https://img.shields.io/npm/v/metascraper-clearbit-logo.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-clearbit-logo) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-clearbit-logo&?style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-clearbit-logo) |
225232

226-
## Write your own plugin
233+
### Write your own plugin
227234

228235
A plugin is the simplest way for extending **metascraper** functionality.
229236

0 commit comments

Comments
 (0)