diff --git a/docs/.config/docs.yaml b/docs/.config/docs.yaml index 2ba122c4..a925de77 100644 --- 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 index af6d7362..0ef14532 100644 --- 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 b/docs/1.guide/99.nightly.md similarity index 100% rename from docs/99.furthor/nightly.md rename to docs/1.guide/99.nightly.md diff --git a/docs/2.utils/0.index.md b/docs/2.utils/0.index.md index 12e3009e..988b2273 100644 --- 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 index e5935603..b8d5beae 100644 --- 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 index b901cdc7..a1b2acb9 100644 --- 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 index 14c88d7d..cbd5414c 100644 --- 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 index d868be80..90cf3fb2 100644 --- 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 index 443c89bd..73d193e8 100644 --- 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 index ca67aff0..c919f606 100644 --- 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 index 9b6b44ea..1c5a2202 100644 --- 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 index c5e19da5..7a9d0f7c 100644 --- 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 index 031cd1fb..56a03392 100644 --- 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 index 3c7be2de..5da60f06 100644 --- 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 index 6e4256aa..3e0bfbda 100644 --- 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 index 1ffd60d0..4760f401 100644 --- 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 new file mode 100644 index 00000000..b4197cbe --- /dev/null +++ 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 b/docs/4.examples/from-expressjs-to-h3.md similarity index 100% rename from docs/4.guides/from-expressjs-to-h3.md rename to docs/4.examples/from-expressjs-to-h3.md diff --git a/docs/4.guides/handle-cookie.md b/docs/4.examples/handle-cookie.md similarity index 100% rename from docs/4.guides/handle-cookie.md rename to docs/4.examples/handle-cookie.md diff --git a/docs/4.guides/handle-session.md b/docs/4.examples/handle-session.md similarity index 100% rename from docs/4.guides/handle-session.md rename to docs/4.examples/handle-session.md diff --git a/docs/4.guides/serve-static-assets.md b/docs/4.examples/serve-static-assets.md similarity index 100% rename from docs/4.guides/serve-static-assets.md rename to docs/4.examples/serve-static-assets.md diff --git a/docs/4.guides/stream-response.md b/docs/4.examples/stream-response.md similarity index 100% rename from docs/4.guides/stream-response.md rename to docs/4.examples/stream-response.md diff --git a/docs/4.guides/validate-data.md b/docs/4.examples/validate-data.md similarity index 100% rename from docs/4.guides/validate-data.md rename to docs/4.examples/validate-data.md diff --git a/docs/bun.lockb b/docs/bun.lockb index c0f9e9cf..e398756e 100755 Binary files a/docs/bun.lockb and b/docs/bun.lockb differ diff --git a/docs/package.json b/docs/package.json index a900c7ca..80744272 100644 --- a/docs/package.json +++ b/docs/package.json @@ -6,6 +6,6 @@ "dev": "undocs dev" }, "devDependencies": { - "undocs": "^0.2.13" + "undocs": "^0.2.16" } }