From 038a0ee160e16622074406dbaf282ab55707d454 Mon Sep 17 00:00:00 2001
From: Valentin Kiselev <mrexox@evilmartians.com>
Date: Tue, 21 Jan 2025 10:41:44 +0300
Subject: [PATCH] docs: update the intro page (#938)

---
 README.md               |  6 ++----
 docs/mdbook/favicon.svg |  1 +
 docs/mdbook/intro.md    | 35 +++++++++++++++++++++++++++++------
 3 files changed, 32 insertions(+), 10 deletions(-)
 create mode 100755 docs/mdbook/favicon.svg

diff --git a/README.md b/README.md
index 10fa0e52..61a27df8 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,10 @@ A Git hooks manager for Node.js, Ruby, Python and many other types of projects.
 * **Powerful.** It allows to control execution and files you pass to your commands.
 * **Simple.** It is single dependency-free binary which can work in any environment.
 
-📖 [Read the introduction post](https://evilmartians.com/chronicles/lefthook-knock-your-teams-code-back-into-shape?utm_source=lefthook)
-
-📖 [Read the documentation][documentation]
+📖 [Introduction post](https://evilmartians.com/chronicles/lefthook-knock-your-teams-code-back-into-shape?utm_source=lefthook)
 
 <a href="https://evilmartians.com/?utm_source=lefthook">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="100%" height="54"></a>
 
 ## Install
 
diff --git a/docs/mdbook/favicon.svg b/docs/mdbook/favicon.svg
new file mode 100755
index 00000000..75c367b8
--- /dev/null
+++ b/docs/mdbook/favicon.svg
@@ -0,0 +1 @@
+<svg width="400" height="350" xmlns="http://www.w3.org/2000/svg"><path fill="#FF1E1E" d="M258 262.6L149 210l-72.4 22.3L5 197.8l76.7-98.4-13.1-24.5L110.8 36l65.4-2.7L251.9 5 386.7 150 323 246.6z"/><path d="M83.2 166.8c28.6 8.6 58.5.6 89.9-24.1l147 95.2-30 18.5h-49l-77.5-38.2-70.8 18-80.4-36.6L69.7 170l13.5-3.2zm52-112.7c10.3-2.7 31.7 22.3 32.7 28.4 3.8 21.2 5.4 35.5-20.7 56.4a69.8 69.8 0 0 1-56.5 15.7l5.2-23.3L77 93.7a96.6 96.6 0 0 1 58.1-39.6z" fill="#BF0000"/><path d="M90.5 243.6l-1.7.5L.3 204.3l2-4.5c14.1-32.6 35-61.2 62.3-85.8a360.6 360.6 0 0 1 11.8-10.2l-4.6-8.7-5.6-10.5-1.8-3.5-1.2-2.3 1.1-2.3c12.3-25 31.5-39 62.8-47.5 19.1-5 35.1-4.7 48 1.4A287.6 287.6 0 0 1 251.3.7l1-.2 144.5 155-1.6 3a3184 3184 0 0 1-37.4 72.6c-17.3 32.6-46 44.4-83.3 39-28-4-58.5-17-95-37.8l-11-6.1c-16.9 2.5-43 8.3-78.1 17.4zM71.2 121.5a237.2 237.2 0 0 0-57.7 77.7l61.2 27.6a517.5 517.5 0 0 1 62.5-18.3 27244.8 27244.8 0 0 0-63.6-35.6l-4.6-2.6 23.3-36.5-11.1-21a351.2 351.2 0 0 0-10 8.7zm37.2 48.6h.1c37.8-6.7 67.4-36.7 78-55.7a214.2 214.2 0 0 0 5.8-9.2L244.1 13a274.8 274.8 0 0 0-74.8 32.4l-10.8-5a377.3 377.3 0 0 1 5.4-3.4 68.2 68.2 0 0 0-34.3 1.8C102 46.1 85.4 58 74.4 78.7l.7 1.2 5.5 10.5 19.6 37a50.4 50.4 0 0 0 19 .2c9.6-1.4 18.4-5 25.5-10.7 14.1-11.4 21.6-20 22.2-27.6.7-9-5.2-21.1-21.7-44.1 23.3 15.6 39.2 40.6 26.4 58.6v.1a57 57 0 0 1-4.3 5.6c-4.2 4.8-9.3 9.5-16.3 15.2a63.4 63.4 0 0 1-30.3 12.8 66 66 0 0 1-19.1.3l-18.5 29a28074.7 28074.7 0 0 1 49.5 27.6v-.2c51-2.7 84-33.6 115.9-84.3-24.4 51.8-54.6 85-101.2 92.8 9.8 5.4 18.6 10.4 26.6 15 50-3.3 80.2-30.7 111.8-80.9-24.1 51.2-51.9 81.4-97 89.2a550.7 550.7 0 0 0 14.7 8 75 75 0 0 1-.5-.5 222.3 222.3 0 0 0 5.5 3 410 410 0 0 0 8.3 4c49.8-3.2 77.6-27.1 109.2-77.3-23.2 49.3-48 76.5-89.7 85 30.5 9 55.2 3.5 80-12 8.5-5.5 28.9-34.5 61-87.2L253.6 16.4 201 110.2a172.9 172.9 0 0 1-30.1 38.4 94 94 0 0 1-62.4 21.5z" fill="#3C0000"/></svg>
diff --git a/docs/mdbook/intro.md b/docs/mdbook/intro.md
index d7bc59e0..49289fc1 100644
--- a/docs/mdbook/intro.md
+++ b/docs/mdbook/intro.md
@@ -1,21 +1,44 @@
 # Introduction
 
+<img align="right" width="147" height="125" title="Lefthook logo"
+     src="./favicon.svg">
+
 **Lefthook** is a Git hooks manager. This documentation provides the reference for installing, configuring and using the lefthook.
 
-Maybe you are looking for
 
-- **[Installation instructions](./installation)** to install lefthook to your system or just project.
+- **[Installation instructions](./installation)** to install lefthook to your OS or project.
 
 - **[Examples](./examples)** of lefthook common usage.
 
-- **[Configuration](./configuration)** with details explanation of lefthook options.
+- **[Configuration](./configuration)** with detailed explanation of lefthook options.
+
+
+**Example:** Run your linters on `pre-commit` hook and forget about the routine.
+
+```yml
+# lefthook.yml
+
+pre-commit:
+  parallel: true
+  jobs:
+    - run: yarn run stylelint --fix {staged_files}
+      glob: "*.css"
+      stage_fixed: true
+
+    - run: yarn run eslint --fix "{staged_files}"
+      glob:
+        - "*.ts"
+        - "*.js"
+        - "*.tsx"
+        - "*.jsx"
+      stage_fixed: true
+```
 
 ---
 
 <a href="https://evilmartians.com/?utm_source=lefthook">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
-
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="100%" height="54"></a>
 
 
-❓If you have a question or found a mistake in the documentation, please create a new [discussion](https://github.com/evilmartians/lefthook/discussions/new/choose). Small contributions help maintaining the quality of the project.
+❓_If you have a question or found a mistake in the documentation, please create a new [discussion](https://github.com/evilmartians/lefthook/discussions/new/choose). Small contributions help maintaining the quality of the project._