summaryrefslogtreecommitdiff
path: root/docs/configuration/starting-url.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/starting-url.md')
-rw-r--r--docs/configuration/starting-url.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/configuration/starting-url.md b/docs/configuration/starting-url.md
new file mode 100644
index 0000000..d5c0965
--- /dev/null
+++ b/docs/configuration/starting-url.md
@@ -0,0 +1,14 @@
+# Stating URL
+
+The `url` config option allows you to specify the initial URL at which the scraper should start its scraping process.
+
+When no value is provided, the scraper will not start and exit immediately.
+
+Example:
+
+```javascript
+export const config = {
+ url: "http://example.com/",
+ // ...
+};
+```