summaryrefslogtreecommitdiff
path: root/docs/configuration/starting-url.md
diff options
context:
space:
mode:
authorPhilipp Tanlak <philipp.tanlak@gmail.com>2023-10-19 17:54:18 +0200
committerPhilipp Tanlak <philipp.tanlak@gmail.com>2023-10-19 18:21:58 +0200
commit0daefa86b400efe08245f4f2a386f7341b76b24e (patch)
tree60d743bb9734a9d7f46701a5ac9026650a330d49 /docs/configuration/starting-url.md
parent03b3be0c3bbc70584e8988e1810dc28eacf4521f (diff)
docs: Add documentationv0.3.0
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/",
+ // ...
+};
+```