diff options
Diffstat (limited to 'docs/configuration/depth.md')
| -rw-r--r-- | docs/configuration/depth.md | 23 |
1 files changed, 0 insertions, 23 deletions
diff --git a/docs/configuration/depth.md b/docs/configuration/depth.md deleted file mode 100644 index cabb0fa..0000000 --- a/docs/configuration/depth.md +++ /dev/null @@ -1,23 +0,0 @@ -# Depth - -The `depth` config option allows you to specify how deep the scraping process should follow links from the initial URL. - -When no value is provided or `depth` is set to `0` link following is disabled and it will only scrape the initial URL. - -Example: - -```javascript -export const config = { - url: "http://example.com/", - depth: 2, - // ... -}; -``` - -With the config provided in the example the scraper would follow links like this: - -``` -http://example.com/ (depth = 0, initial URL) -↳ http://example.com/deeply (depth = 1) - ↳ http://example.com/deeply/nested (depth = 2) -``` |