11
11
12
12
## Table of Contents
13
13
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 )
21
28
22
29
## Getting Started
23
30
@@ -117,11 +124,11 @@ The configuration file will be resolved starting from the location of the file b
117
124
118
125
** Note:** Using a configuration file you need to explicitly add all the plugins that you want to use.
119
126
120
- #### Basic Configuration
127
+ ### Basic Configuration
121
128
122
129
Declared an ` array ` of ` rules ` , specifying each rule as ` string ` name of the module to load.
123
130
124
- ##### JSON
131
+ #### JSON
125
132
126
133
``` json
127
134
// .metascraperrc
@@ -139,7 +146,7 @@ Declared an `array` of `rules`, specifying each rule as `string` name of the mod
139
146
}
140
147
```
141
148
142
- ##### YAML
149
+ #### YAML
143
150
144
151
``` yaml
145
152
# .metascraperrc
@@ -154,11 +161,11 @@ rules:
154
161
- metascraper-url
155
162
` ` `
156
163
157
- #### Advanced Configuration
164
+ ### Advanced Configuration
158
165
159
166
Additionally, you can pass specific configuration per module using a ` object` declaration:
160
167
161
- # #### JSON
168
+ # ### JSON
162
169
163
170
` ` ` json
164
171
// .metascraperrc
@@ -179,7 +186,7 @@ Additionally, you can pass specific configuration per module using a `object` de
179
186
}
180
187
` ` `
181
188
182
- # #### YAML
189
+ # ### YAML
183
190
184
191
` ` ` yaml
185
192
# .metascraperrc
@@ -200,7 +207,7 @@ rules:
200
207
201
208
?> Can't find a plugin that you want? Let's [open an issue](https://github.com/microlinkhq/metacraper/issues) to create it.
202
209
203
- # # Core Plugins
210
+ # ## Core Plugins
204
211
205
212
These plugins will be shipped with **metascraper** and loaded by default.
206
213
@@ -215,15 +222,15 @@ These plugins will be shipped with **metascraper** and loaded by default.
215
222
| [`metascraper-title`](/packages/metascraper-title) | [](https://www.npmjs.com/package/metascraper-title) | [](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-title) |
216
223
| [`metascraper-url`](/packages/metascraper-url) | [](https://www.npmjs.com/package/metascraper-url) | [](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-url) |
217
224
218
- # # Community Plugins
225
+ # ## Community Plugins
219
226
220
227
These plugins will not be shipped with **metascraper** by default and need to be specific using a configuration file.
221
228
222
229
| Package | Version | Dependencies |
223
230
|--------|-------|------------|
224
231
| [`metascraper-clearbit-logo`](/packages/metascraper-clearbit-logo) | [](https://www.npmjs.com/package/metascraper-clearbit-logo) | [](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-clearbit-logo) |
225
232
226
- # # Write your own plugin
233
+ # ## Write your own plugin
227
234
228
235
A plugin is the simplest way for extending **metascraper** functionality.
229
236
0 commit comments