better docs

jycouet · Nov 4, 2024 · 863b74a · 863b74a
1 parent 5885f43
commit 863b74a
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/website/src/pages/docs/tools/08_eslint-config.mdx b/website/src/pages/docs/tools/08_eslint-config.mdx
@@ -65,10 +65,21 @@ node_modules
 !.env.example
 
 # Ignore files for PNPM, NPM and YARN
+package.json
 pnpm-lock.yaml
 package-lock.json
 yarn.lock
 
 # Ignore files that are project specific
 /db
 ```
+
+### Add this to your `package.json`
+
+```json filename="package.json"
+scripts: {
+  "//// ---- BEST PRACTICES ---- ////": "",
+  "format": "kitql-lint -f",
+  "lint": "kitql-lint",
+}
+```