enhance: merge upstream/main

Author: LaurenceJJones

.github/workflows/lint.yaml

@@ -0,0 +1,31 @@
+name: Code quality
+
+on:
+  pull_request: 
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+          cache-dependency-path: crowdsec-docs/package-lock.json
+        
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: ./crowdsec-docs/
+
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
+        with:
+          version: latest
+
+      - name: Run Biome
+        run: biome ci .

.gitignore

@@ -1,2 +1,3 @@
 .vscode
 node_modules
+.history

README.md

@@ -6,6 +6,12 @@ Online version of this documentation is available here: https://doc.crowdsec.net
 
 The documentation is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
+## Pre-requisites
+
+- Node.js (version 20 or later)
+- npm (Node package manager)
+- VSCode with recommended extensions installed (see `.vscode/extensions.json`)
+
 ## Installation
 
 ```console
@@ -28,3 +34,12 @@ npm run build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 you can also use the `npm run serve` command to test the build locally.
+
+## Linting and Formatting
+
+This project uses [Biomes](https://biomejs.dev/) for linting and formatting. You can run the following commands:
+
+```console
+npm run lint
+npm run format
+```

biome.json

@@ -0,0 +1,64 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.0.6/schema.json",
+	"vcs": { "enabled": false, "clientKind": "git", "useIgnoreFile": false },
+	"files": {
+		"ignoreUnknown": false,
+		"includes": [
+			"crowdsec-docs/**/*.ts",
+			"crowdsec-docs/**/*.tsx",
+			"crowdsec-docs/**/*.css",
+			"!**/node_modules/**",
+			"!crowdsec-docs/plugins/**",
+			"!crowdsec-docs/build/**"
+		]
+	},
+	"formatter": {
+		"enabled": true,
+		"formatWithErrors": false,
+		"indentStyle": "tab",
+		"indentWidth": 4,
+		"lineEnding": "lf",
+		"lineWidth": 140,
+		"attributePosition": "auto",
+		"bracketSameLine": false,
+		"bracketSpacing": true,
+		"expand": "auto",
+		"useEditorconfig": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"style": {
+				"useImportType": "off"
+			}
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"jsxQuoteStyle": "double",
+			"quoteProperties": "asNeeded",
+			"trailingCommas": "es5",
+			"semicolons": "always",
+			"arrowParentheses": "always",
+			"bracketSameLine": false,
+			"quoteStyle": "double",
+			"attributePosition": "auto",
+			"bracketSpacing": true
+		}
+	},
+	"html": { "formatter": { "selfCloseVoidElements": "always" } },
+	"css": {
+		"formatter": {
+			"enabled": true,
+			"indentStyle": "tab",
+			"indentWidth": 4,
+			"lineEnding": "lf",
+			"lineWidth": 140
+		}
+	},
+	"assist": {
+		"enabled": true,
+		"actions": { "source": { "organizeImports": "on" } }
+	}
+}

crowdsec-docs/.npmrc

@@ -0,0 +1 @@
+v20.18.1

crowdsec-docs/.prettierrc

@@ -3,18 +3,19 @@
     "tailwind": {
       "config": "tailwind.config.js",
       "css": "src/css/custom.css",
-      "baseColor": "neutral",
-      "prefix": "tw-",
-      "cssVariables": false
+      "baseColor": "gray",
+      "prefix": "",
+      "cssVariables": true
     },
     "rsc": true,
     "aliases": {
-        "utils": "@/src/utils",
-        "components": "@/src/components",
-        "ui": "@/src/ui",
-        "hooks": "@/src/hooks",
-        "lib": "@/src/lib"
+        "utils": "@site/src/utils",
+        "components": "@site/src/components",
+        "ui": "@site/src/ui",
+        "hooks": "@site/src/hooks",
+        "lib": "@site/src/lib"
     },
-    "style": "default"
+    "style": "default",
+    "iconLibrary": "lucide"
   }
 

crowdsec-docs/babel.config.js

@@ -3,7 +3,7 @@ id: traefik
 title: Traefik
 ---
 
-import FormattedTabs from '@site/src/components/FormattedTabs'; 
+import FormattedTabs from '@site/src/components/formatted-tabs'; 
 
 # CrowdSec WAF QuickStart for Traefik
 

crowdsec-docs/components.json

@@ -4,7 +4,7 @@ id: intro
 ---
 
 import useBaseUrl from "@docusaurus/useBaseUrl"
-import AcademyPromo from "@site/src/components/AcademyPromo"
+import AcademyPromo from "@site/src/components/academy-promo"
 
 # Security Engine Overview