chore: update docs

unjs · Feb 23, 2024 · 1d8b389 · 1d8b389
1 parent c8aa150
commit 1d8b389
Show file tree

Hide file tree

Showing 25 changed files with 71 additions and 3 deletions.
diff --git a/docs/.config/docs.yaml b/docs/.config/docs.yaml
@@ -5,6 +5,7 @@ description:
   H(TTP) server framework built for high performance and portability running
   in any JavaScript runtime.
 github: unjs/h3
+themeColor: amber
 url: https://h3.unjs.io
 # automd: true # HMR seems unstable
 redirects: {}

diff --git a/docs/1.guide/1.index.md b/docs/1.guide/1.index.md
@@ -1,3 +1,7 @@
+---
+icon: ph:book-open-duotone
+---
+
 # Getting Started
 
 > Getting started with h3

diff --git a/docs/99.furthor/nightly.md → docs/1.guide/99.nightly.md b/docs/99.furthor/nightly.md → docs/1.guide/99.nightly.md
diff --git a/docs/2.utils/0.index.md b/docs/2.utils/0.index.md
@@ -1,4 +1,8 @@
-# Composable Utils
+---
+icon: ph:function-bold
+---
+
+# Utils
 
 > Keep your severs light and fast with composables.
 

diff --git a/docs/2.utils/1.request.md b/docs/2.utils/1.request.md
@@ -1,3 +1,7 @@
+---
+icon: material-symbols-light:input
+---
+
 # Request
 
 > Utilities to access incoming request

diff --git a/docs/2.utils/2.reponse.md b/docs/2.utils/2.reponse.md
@@ -1,3 +1,7 @@
+---
+icon: material-symbols-light:output
+---
+
 # Response
 
 > Utilities to send response headers and data

diff --git a/docs/2.utils/98.advanced.md b/docs/2.utils/98.advanced.md
@@ -1,3 +1,7 @@
+---
+icon: mingcute:plus-line
+---
+
 # Advanced
 
 > More utilities

diff --git a/docs/2.utils/99.community.md b/docs/2.utils/99.community.md
@@ -1,3 +1,7 @@
+---
+icon: lets-icons:external
+---
+
 # Community
 
 > Utils from community 💛

diff --git a/docs/3.adapters/0.index.md b/docs/3.adapters/0.index.md
@@ -1,4 +1,8 @@
-# Runtime Adapters
+---
+icon: codicon:run-all
+---
+
+# Adapters
 
 > Run h3 everywhere using adapters.
 

diff --git a/docs/3.adapters/1.node.md b/docs/3.adapters/1.node.md
@@ -1,3 +1,7 @@
+---
+icon: akar-icons:node-fill
+---
+
 # Node.js
 
 > Natively run h3 servers with Node.js.

diff --git a/docs/3.adapters/2.web.md b/docs/3.adapters/2.web.md
@@ -1,3 +1,7 @@
+---
+icon: twemoji:spider-web
+---
+
 # Web
 
 > Run your h3 apps in edge runtimes with Web API compatibility.

diff --git a/docs/3.adapters/3.plain.md b/docs/3.adapters/3.plain.md
@@ -1,3 +1,7 @@
+---
+icon: material-symbols-light:data-object
+---
+
 # Plain
 
 > Run h3 servers into any unknown runtime!

diff --git a/docs/3.adapters/bun.md b/docs/3.adapters/bun.md
@@ -1,3 +1,7 @@
+---
+icon: simple-icons:bun
+---
+
 # Bun
 
 > Run your h3 apps with Bun

diff --git a/docs/3.adapters/cloudflare.md b/docs/3.adapters/cloudflare.md
@@ -1,3 +1,7 @@
+---
+icon: devicon-plain:cloudflareworkers
+---
+
 # Cloudflare
 
 > Run your h3 apps in Cloudflare Workers

diff --git a/docs/3.adapters/deno.md b/docs/3.adapters/deno.md
@@ -1,3 +1,7 @@
+---
+icon: teenyicons:deno-solid
+---
+
 # Deno
 
 > Run your h3 apps in Deno Deploy

diff --git a/docs/3.adapters/netlify.md b/docs/3.adapters/netlify.md
@@ -1,3 +1,7 @@
+---
+icon: teenyicons:netlify-outline
+---
+
 # Netlify
 
 > Run your h3 apps in Netlify Edge

diff --git a/docs/4.examples/0.index.md b/docs/4.examples/0.index.md
@@ -0,0 +1,11 @@
+---
+icon: ph:code
+---
+
+# Examples
+
+> Common examples for h3.
+
+::read-more{to="https://github.com/unjs/h3/tree/main/examples"}
+Check [`examples/` dir](https://github.com/unjs/h3/tree/main/examples) for more examples.
+::
diff --git a/docs/4.guides/from-expressjs-to-h3.md → docs/4.examples/from-expressjs-to-h3.md b/docs/4.guides/from-expressjs-to-h3.md → docs/4.examples/from-expressjs-to-h3.md
diff --git a/docs/4.guides/handle-cookie.md → docs/4.examples/handle-cookie.md b/docs/4.guides/handle-cookie.md → docs/4.examples/handle-cookie.md
diff --git a/docs/4.guides/handle-session.md → docs/4.examples/handle-session.md b/docs/4.guides/handle-session.md → docs/4.examples/handle-session.md
diff --git a/docs/4.guides/serve-static-assets.md → docs/4.examples/serve-static-assets.md b/docs/4.guides/serve-static-assets.md → docs/4.examples/serve-static-assets.md
diff --git a/docs/4.guides/stream-response.md → docs/4.examples/stream-response.md b/docs/4.guides/stream-response.md → docs/4.examples/stream-response.md
diff --git a/docs/4.guides/validate-data.md → docs/4.examples/validate-data.md b/docs/4.guides/validate-data.md → docs/4.examples/validate-data.md
diff --git a/docs/bun.lockb b/docs/bun.lockb
diff --git a/docs/package.json b/docs/package.json
@@ -6,6 +6,6 @@
     "dev": "undocs dev"
   },
   "devDependencies": {
-    "undocs": "^0.2.13"
+    "undocs": "^0.2.16"
   }
 }