Skip to content

🕷️ The BEST Web Scraping framework that handles everything from a single request to a full-scale crawl! Don't be shy, join here: https://discord.gg/EMgGbDceNQ and follow here for daily tips and tricks: https://x.com/Scrapling_dev

docs: moving readme files to be outside of the website build

Karim shoair0e2e9fb2ed67
diff --git a/docs/requirements.txt b/docs/requirements.txt
index c2c5d54..52ee54b 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,8 +1,8 @@
-mkdocstrings>=1.0.0
+zensical>=0.0.21
+mkdocstrings>=1.0.3
mkdocstrings-python>=2.0.1
griffe-inherited-docstrings
griffe-runtime-objects
griffe-sphinx
-mkdocs-material[imaging]>=9.7.1
-black>=25.12.0
+black>=26.1.0
pngquant
\ No newline at end of file
diff --git a/docs/README.md b/repo_docs/README.md
similarity index 94%
rename from docs/README.md
rename to repo_docs/README.md
index b4d1950..e34a85e 100644
--- a/docs/README.md
+++ b/repo_docs/README.md
@@ -1,13 +1,17 @@
-Automated translations: [العربيه](https://github.com/D4Vinci/Scrapling/blob/main/docs/README_AR.md) | [Español](https://github.com/D4Vinci/Scrapling/blob/main/docs/README_ES.md) | [Deutsch](https://github.com/D4Vinci/Scrapling/blob/main/docs/README_DE.md) | [简体中文](https://github.com/D4Vinci/Scrapling/blob/main/docs/README_CN.md) | [日本語](https://github.com/D4Vinci/Scrapling/blob/main/docs/README_JP.md) | [Русский](https://github.com/D4Vinci/Scrapling/blob/main/docs/README_RU.md)
-
+<h1 align="center">
+ <a href="https://scrapling.readthedocs.io">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_dark.svg?sanitize=true">
+ <img alt="Scrapling Poster" src="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_light.svg?sanitize=true">
+ </picture>
+ </a>
+ <br>
+ <small>Web Scraping have never been easier!</small>
+</h1>
-<p align=center>
- <br>
- <a href="https://scrapling.readthedocs.io/en/latest/" target="_blank"><img src="https://raw.githubusercontent.com/D4Vinci/Scrapling/main/images/poster.png" style="width: 50%; height: 100%;" alt="main poster"/></a>
- <br>
- <i><code>Easy, effortless Web Scraping as it should be!</code></i>
-</p>
<p align="center">
+ [العربيه](https://github.com/D4Vinci/Scrapling/blob/main/repo_docs/README_AR.md) | [Español](https://github.com/D4Vinci/Scrapling/blob/main/repo_docs/README_ES.md) | [Deutsch](https://github.com/D4Vinci/Scrapling/blob/main/repo_docs/README_DE.md) | [简体中文](https://github.com/D4Vinci/Scrapling/blob/main/repo_docs/README_CN.md) | [日本語](https://github.com/D4Vinci/Scrapling/blob/main/repo_docs/README_JP.md) | [Русский](https://github.com/D4Vinci/Scrapling/blob/main/repo_docs/README_RU.md)
+ <br/>
<a href="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml" alt="Tests">
<img alt="Tests" src="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml/badge.svg"></a>
<a href="https://badge.fury.io/py/Scrapling" alt="PyPI version">
diff --git a/docs/README_AR.md b/repo_docs/README_AR.md
similarity index 97%
rename from docs/README_AR.md
rename to repo_docs/README_AR.md
index 8a21afb..0463398 100644
--- a/docs/README_AR.md
+++ b/repo_docs/README_AR.md
@@ -1,9 +1,13 @@
-<p align=center>
- <br>
- <a href="https://scrapling.readthedocs.io/en/latest/" target="_blank"><img src="https://raw.githubusercontent.com/D4Vinci/Scrapling/main/images/poster.png" style="width: 50%; height: 100%;" alt="main poster"/></a>
- <br>
- <i><code>استخراج بيانات الويب بسهولة ويسر كما يجب أن يكون!</code></i>
-</p>
+<h1 align="center">
+ <a href="https://scrapling.readthedocs.io">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_dark.svg?sanitize=true">
+ <img alt="Scrapling Poster" src="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_light.svg?sanitize=true">
+ </picture>
+ </a>
+ <br>
+ <small>Web Scraping have never been easier!</small>
+</h1>
<p align="center">
<a href="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml" alt="Tests">
<img alt="Tests" src="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml/badge.svg"></a>
diff --git a/docs/README_CN.md b/repo_docs/README_CN.md
similarity index 97%
rename from docs/README_CN.md
rename to repo_docs/README_CN.md
index ac83218..93fb5e1 100644
--- a/docs/README_CN.md
+++ b/repo_docs/README_CN.md
@@ -1,9 +1,13 @@
-<p align=center>
- <br>
- <a href="https://scrapling.readthedocs.io/en/latest/" target="_blank"><img src="https://raw.githubusercontent.com/D4Vinci/Scrapling/main/images/poster.png" style="width: 50%; height: 100%;" alt="main poster"/></a>
- <br>
- <i><code>简单、轻松的网页抓取,本该如此!</code></i>
-</p>
+<h1 align="center">
+ <a href="https://scrapling.readthedocs.io">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_dark.svg?sanitize=true">
+ <img alt="Scrapling Poster" src="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_light.svg?sanitize=true">
+ </picture>
+ </a>
+ <br>
+ <small>Web Scraping have never been easier!</small>
+</h1>
<p align="center">
<a href="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml" alt="Tests">
<img alt="Tests" src="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml/badge.svg"></a>
diff --git a/docs/README_DE.md b/repo_docs/README_DE.md
similarity index 97%
rename from docs/README_DE.md
rename to repo_docs/README_DE.md
index 3013d51..cec06af 100644
--- a/docs/README_DE.md
+++ b/repo_docs/README_DE.md
@@ -1,9 +1,13 @@
-<p align=center>
- <br>
- <a href="https://scrapling.readthedocs.io/en/latest/" target="_blank"><img src="https://raw.githubusercontent.com/D4Vinci/Scrapling/main/images/poster.png" style="width: 50%; height: 100%;" alt="main poster"/></a>
- <br>
- <i><code>Einfaches, müheloses Web Scraping, wie es sein sollte!</code></i>
-</p>
+<h1 align="center">
+ <a href="https://scrapling.readthedocs.io">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_dark.svg?sanitize=true">
+ <img alt="Scrapling Poster" src="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_light.svg?sanitize=true">
+ </picture>
+ </a>
+ <br>
+ <small>Web Scraping have never been easier!</small>
+</h1>
<p align="center">
<a href="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml" alt="Tests">
<img alt="Tests" src="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml/badge.svg"></a>
diff --git a/docs/README_ES.md b/repo_docs/README_ES.md
similarity index 97%
rename from docs/README_ES.md
rename to repo_docs/README_ES.md
index a913608..9c27995 100644
--- a/docs/README_ES.md
+++ b/repo_docs/README_ES.md
@@ -1,9 +1,13 @@
-<p align=center>
- <br>
- <a href="https://scrapling.readthedocs.io/en/latest/" target="_blank"><img src="https://raw.githubusercontent.com/D4Vinci/Scrapling/main/images/poster.png" style="width: 50%; height: 100%;" alt="main poster"/></a>
- <br>
- <i><code>¡Web Scraping fácil y sin esfuerzo como debería ser!</code></i>
-</p>
+<h1 align="center">
+ <a href="https://scrapling.readthedocs.io">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_dark.svg?sanitize=true">
+ <img alt="Scrapling Poster" src="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_light.svg?sanitize=true">
+ </picture>
+ </a>
+ <br>
+ <small>Web Scraping have never been easier!</small>
+</h1>
<p align="center">
<a href="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml" alt="Tests">
<img alt="Tests" src="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml/badge.svg"></a>
diff --git a/docs/README_JP.md b/repo_docs/README_JP.md
similarity index 97%
rename from docs/README_JP.md
rename to repo_docs/README_JP.md
index 1427607..f86a7b1 100644
--- a/docs/README_JP.md
+++ b/repo_docs/README_JP.md
@@ -1,9 +1,13 @@
-<p align=center>
- <br>
- <a href="https://scrapling.readthedocs.io/en/latest/" target="_blank"><img src="https://raw.githubusercontent.com/D4Vinci/Scrapling/main/images/poster.png" style="width: 50%; height: 100%;" alt="main poster"/></a>
- <br>
- <i><code>簡単で効率的なウェブスクレイピング、あるべき姿!</code></i>
-</p>
+<h1 align="center">
+ <a href="https://scrapling.readthedocs.io">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_dark.svg?sanitize=true">
+ <img alt="Scrapling Poster" src="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_light.svg?sanitize=true">
+ </picture>
+ </a>
+ <br>
+ <small>Web Scraping have never been easier!</small>
+</h1>
<p align="center">
<a href="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml" alt="Tests">
<img alt="Tests" src="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml/badge.svg"></a>
diff --git a/docs/README_RU.md b/repo_docs/README_RU.md
similarity index 97%
rename from docs/README_RU.md
rename to repo_docs/README_RU.md
index fed6f26..12f0492 100644
--- a/docs/README_RU.md
+++ b/repo_docs/README_RU.md
@@ -1,9 +1,13 @@
-<p align=center>
- <br>
- <a href="https://scrapling.readthedocs.io/en/latest/" target="_blank"><img src="https://raw.githubusercontent.com/D4Vinci/Scrapling/main/images/poster.png" style="width: 50%; height: 100%;" alt="main poster"/></a>
- <br>
- <i><code>Простой, легкий веб-скрапинг, каким он и должен быть!</code></i>
-</p>
+<h1 align="center">
+ <a href="https://scrapling.readthedocs.io">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_dark.svg?sanitize=true">
+ <img alt="Scrapling Poster" src="https://raw.githubusercontent.com/D4Vinci/Scrapling/v4/docs/assets/cover_light.svg?sanitize=true">
+ </picture>
+ </a>
+ <br>
+ <small>Web Scraping have never been easier!</small>
+</h1>
<p align="center">
<a href="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml" alt="Tests">
<img alt="Tests" src="https://github.com/D4Vinci/Scrapling/actions/workflows/tests.yml/badge.svg"></a>