update docs

manusant · Feb 23, 2024 · 82cf527 · 82cf527
1 parent 3efab90
commit 82cf527
Show file tree

Hide file tree

Showing 20 changed files with 271 additions and 361 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Katxupa
 
 <p align="center">
-  <img src="/docs/assets/logo.png" />
+  <img src="/assets/logo.png" />
   <br/>
   <span align="center" style="font-size: x-large; font-weight: normal">
   Delicious Dish for Typescript and JavaScript projects

diff --git a/docs/assets/logo.png → assets/logo.png b/docs/assets/logo.png → assets/logo.png
diff --git a/docs/assets/docs-home.png b/docs/assets/docs-home.png
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -3,24 +3,22 @@
     --dark-hl-0: #DCDCAA;
     --light-hl-1: #000000;
     --dark-hl-1: #D4D4D4;
-    --light-hl-2: #A31515;
-    --dark-hl-2: #CE9178;
-    --light-hl-3: #0000FF;
-    --dark-hl-3: #569CD6;
-    --light-hl-4: #0070C1;
-    --dark-hl-4: #4FC1FF;
-    --light-hl-5: #001080;
-    --dark-hl-5: #9CDCFE;
-    --light-hl-6: #098658;
-    --dark-hl-6: #B5CEA8;
-    --light-hl-7: #000000FF;
-    --dark-hl-7: #D4D4D4;
+    --light-hl-2: #0000FF;
+    --dark-hl-2: #569CD6;
+    --light-hl-3: #001080;
+    --dark-hl-3: #9CDCFE;
+    --light-hl-4: #A31515;
+    --dark-hl-4: #CE9178;
+    --light-hl-5: #008000;
+    --dark-hl-5: #6A9955;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
+    --light-hl-7: #098658;
+    --dark-hl-7: #B5CEA8;
     --light-hl-8: #AF00DB;
     --dark-hl-8: #C586C0;
-    --light-hl-9: #008000;
-    --dark-hl-9: #6A9955;
-    --light-hl-10: #267F99;
-    --dark-hl-10: #4EC9B0;
+    --light-hl-9: #267F99;
+    --dark-hl-9: #4EC9B0;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -36,7 +34,6 @@
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
-    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 } }
 
@@ -51,7 +48,6 @@
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
-    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 } }
 
@@ -66,7 +62,6 @@
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
-    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 }
 
@@ -81,7 +76,6 @@
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
-    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 }
 
@@ -95,5 +89,4 @@
 .hl-7 { color: var(--hl-7); }
 .hl-8 { color: var(--hl-8); }
 .hl-9 { color: var(--hl-9); }
-.hl-10 { color: var(--hl-10); }
 pre, code { background: var(--code-background); }
diff --git a/docs/classes/Duration.html b/docs/classes/Duration.html
diff --git a/docs/classes/Err.html b/docs/classes/Err.html
diff --git a/docs/classes/Left.html b/docs/classes/Left.html
diff --git a/docs/classes/NoSuchElementError.html b/docs/classes/NoSuchElementError.html
diff --git a/docs/classes/Ok.html b/docs/classes/Ok.html
diff --git a/docs/classes/Optional.html b/docs/classes/Optional.html
diff --git a/docs/classes/Range.html b/docs/classes/Range.html
diff --git a/docs/classes/Reducer.html b/docs/classes/Reducer.html
diff --git a/docs/classes/Right.html b/docs/classes/Right.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/Comparable.html b/docs/interfaces/Comparable.html
diff --git a/docs/interfaces/Comparator.html b/docs/interfaces/Comparator.html
diff --git a/docs/interfaces/InlineComparator.html b/docs/interfaces/InlineComparator.html
diff --git a/docs/types/Either.html b/docs/types/Either.html
diff --git a/docs/types/Result.html b/docs/types/Result.html
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
   "scripts": {
     "build": "tsc",
     "test": "jest",
+    "doc": "npx typedoc src/index.ts",
     "release": "pnpm build && pnpm test && pnpm publish --no-git-checks"
   },
   "devDependencies": {