initialize docs (#595)

Co-authored-by: barbapapazes <e.soubiran25@gmail.com>
Co-authored-by: Estéban <esteban.soubiran@insa-cvl.fr>

.gitignore

@@ -7,3 +7,4 @@ coverage
 .idea
 .eslintcache
 tsconfig.vitest-temp.json
+.DS_Store

README.md

@@ -27,313 +27,6 @@ H3 (pronounced as /eɪtʃθriː/, like h-3) is a minimal h(ttp) framework built
 
 ✔️  **Compatible:** Compatibility layer with node/connect/express middleware
 
-## Install
-
-```bash
-# Using npm
-npm install h3
-
-# Using yarn
-yarn add h3
-
-# Using pnpm
-pnpm add h3
-```
-
-<details>
-  <summary>Using Nightly Releases</summary>
-
-If you are directly using `h3` as a dependency:
-
-```json
-{
-  "dependencies": {
-    "h3": "npm:h3-nightly@latest"
-  }
-}
-```
-
-If you are using a framework ([Nuxt](https://nuxt.com/) or [Nitro](https://nitro.unjs.io/)) that is using `h3`:
-
-pnpm and yarn:
-
-```json
-{
-  "resolutions": {
-    "h3": "npm:h3-nightly@latest"
-  }
-}
-```
-
-npm:
-
-```json
-{
-  "overrides": {
-    "h3": "npm:h3-nightly@latest"
-  }
-}
-```
-
-**Note:** Make sure to recreate lockfile and `node_modules` after reinstall to avoid hoisting issues.
-
-</details>
-
-## Usage
-
-```ts
-import { createServer } from "node:http";
-import { createApp, eventHandler, toNodeListener } from "h3";
-
-const app = createApp();
-app.use(
-  "/",
-  eventHandler(() => "Hello world!"),
-);
-
-createServer(toNodeListener(app)).listen(process.env.PORT || 3000);
-```
-
-Example using <a href="https://github.com/unjs/listhen">listhen</a> for an elegant listener:
-
-```ts
-import { createApp, eventHandler, toNodeListener } from "h3";
-import { listen } from "listhen";
-
-const app = createApp();
-app.use(
-  "/",
-  eventHandler(() => "Hello world!"),
-);
-
-listen(toNodeListener(app));
-```
-
-## Router
-
-The `app` instance created by `h3` uses a middleware stack (see [how it works](./src/app.ts)) with the ability to match route prefix and apply matched middleware.
-
-To opt-in using a more advanced and convenient routing system, we can create a router instance and register it to app instance.
-
-```ts
-import { createApp, eventHandler, createRouter } from "h3";
-
-const app = createApp();
-
-const router = createRouter()
-  .get(
-    "/",
-    eventHandler(() => "Hello World!"),
-  )
-  .get(
-    "/hello/:name",
-    eventHandler((event) => `Hello ${event.context.params.name}!`),
-  );
-
-app.use(router);
-```
-
-**Tip:** We can register the same route more than once with different methods.
-
-Routes are internally stored in a [Radix Tree](https://en.wikipedia.org/wiki/Radix_tree) and matched using [unjs/radix3](https://github.com/unjs/radix3).
-
-For using nested routers, see [this example](./examples/nested-router.ts)
-
-## More app usage examples
-
-```js
-// Handle can directly return object or Promise<object> for JSON response
-app.use(
-  "/api",
-  eventHandler((event) => ({ url: event.node.req.url })),
-);
-
-// We can have better matching other than quick prefix match
-app.use(
-  "/odd",
-  eventHandler(() => "Is odd!"),
-  { match: (url) => url.substr(1) % 2 },
-);
-
-// Handle can directly return string for HTML response
-app.use(eventHandler(() => "<h1>Hello world!</h1>"));
-
-// We can chain calls to .use()
-app
-  .use(
-    "/1",
-    eventHandler(() => "<h1>Hello world!</h1>"),
-  )
-  .use(
-    "/2",
-    eventHandler(() => "<h1>Goodbye!</h1>"),
-  );
-
-// We can proxy requests and rewrite cookie's domain and path
-app.use(
-  "/api",
-  eventHandler((event) =>
-    proxyRequest(event, "https://example.com", {
-      // f.e. keep one domain unchanged, rewrite one domain and remove other domains
-      cookieDomainRewrite: {
-        "example.com": "example.com",
-        "example.com": "somecompany.co.uk",
-        "*": "",
-      },
-      cookiePathRewrite: {
-        "/": "/api",
-      },
-    }),
-  ),
-);
-
-// Legacy middleware with 3rd argument are automatically promisified
-app.use(
-  fromNodeMiddleware((req, res, next) => {
-    req.setHeader("x-foo", "bar");
-    next();
-  }),
-);
-
-// Lazy loaded routes using { lazy: true }
-app.use("/big", () => import("./big-handler"), { lazy: true });
-```
-
-## Utilities
-
-H3 has a concept of composable utilities that accept `event` (from `eventHandler((event) => {})`) as their first argument. This has several performance benefits over injecting them to `event` or `app` instances in global middleware commonly used in Node.js frameworks, such as Express. This concept means only required code is evaluated and bundled, and the rest of the utilities can be tree-shaken when not used.
-
-👉 You can check list of exported built-in utils from [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).
-
-#### Body
-
-- `readRawBody(event, encoding?)`
-- `readBody(event)`
-- `readValidatedBody(event, validate)`
-- `readMultipartFormData(event)`
-
-#### Request
-
-- `getQuery(event)`
-- `getValidatedQuery(event, validate)`
-- `getRouterParams(event, { decode? })`
-- `getRouterParam(event, name, { decode? })`
-- `getValidatedRouterParams(event, validate, { decode? })`
-- `getMethod(event, default?)`
-- `isMethod(event, expected, allowHead?)`
-- `assertMethod(event, expected, allowHead?)`
-- `getRequestHeaders(event)` (alias: `getHeaders`)
-- `getRequestHeader(event, name)` (alias: `getHeader`)
-- `getRequestURL(event)`
-- `getRequestHost(event)`
-- `getRequestProtocol(event)`
-- `getRequestPath(event)`
-- `getRequestIP(event, { xForwardedFor: boolean })`
-
-#### Response
-
-- `send(event, data, type?)`
-- `sendNoContent(event, code = 204)`
-- `setResponseStatus(event, status)`
-- `getResponseStatus(event)`
-- `getResponseStatusText(event)`
-- `getResponseHeaders(event)`
-- `getResponseHeader(event, name)`
-- `setResponseHeaders(event, headers)` (alias: `setHeaders`)
-- `setResponseHeader(event, name, value)` (alias: `setHeader`)
-- `appendResponseHeaders(event, headers)` (alias: `appendHeaders`)
-- `appendResponseHeader(event, name, value)` (alias: `appendHeader`)
-- `defaultContentType(event, type)`
-- `sendRedirect(event, location, code=302)`
-- `isStream(data)`
-- `sendStream(event, data)`
-- `writeEarlyHints(event, links, callback)`
-
-#### Sanitize
-
-- `sanitizeStatusMessage(statusMessage)`
-- `sanitizeStatusCode(statusCode, default = 200)`
-
-#### Error
-
-- `sendError(event, error, debug?)`
-- `createError({ statusCode, statusMessage, data? })`
-
-#### Route
-
-- `useBase(base, handler)`
-
-#### Proxy
-
-- `sendProxy(event, { target, ...options })`
-- `proxyRequest(event, { target, ...options })`
-- `fetchWithEvent(event, req, init, { fetch? }?)`
-- `getProxyRequestHeaders(event)`
-
-#### Cookie
-
-- `parseCookies(event)`
-- `getCookie(event, name)`
-- `setCookie(event, name, value, opts?)`
-- `deleteCookie(event, name, opts?)`
-- `splitCookiesString(cookiesString)`
-
-#### Session
-
-- `useSession(event, config = { password, maxAge?, name?, cookie?, seal?, crypto? })`
-- `getSession(event, config)`
-- `updateSession(event, config, update)`
-- `sealSession(event, config)`
-- `unsealSession(event, config, sealed)`
-- `clearSession(event, config)`
-
-#### Cache
-
-- `handleCacheHeaders(event, opts)`
-
-#### Cors
-
-- `handleCors(options)` (see [h3-cors](https://github.com/NozomuIkuta/h3-cors) for more detail about options)
-- `isPreflightRequest(event)`
-- `isCorsOriginAllowed(event)`
-- `appendCorsHeaders(event, options)` (see [h3-cors](https://github.com/NozomuIkuta/h3-cors) for more detail about options)
-- `appendCorsPreflightHeaders(event, options)` (see [h3-cors](https://github.com/NozomuIkuta/h3-cors) for more detail about options)
-
-## Community Packages
-
-You can use more H3 event utilities made by the community.
-
-Please check their READMEs for more details.
-
-PRs are welcome to add your packages.
-
-- [h3-typebox](https://github.com/kevinmarrec/h3-typebox)
-  - `validateBody(event, schema)`
-  - `validateQuery(event, schema)`
-- [h3-zod](https://github.com/wobsoriano/h3-zod)
-  - `useValidatedBody(event, schema)`
-  - `useValidatedQuery(event, schema)`
-- [h3-valibot](https://github.com/intevel/h3-valibot)
-  - `useValidateBody(event, schema)`
-  - `useValidateParams(event, schema)`
-- [h3-compression](https://github.com/CodeDredd/h3-compression)
-  - `useGZipCompression(event, response)`
-  - `useDeflateCompression(event, response)`
-  - `useBrotliCompression(event, response)`
-  - `useCompression(event, response)`
-  - `useGZipCompressionStream(event, response)`
-  - `useDeflateCompressionStream(event, response)`
-  - `useCompressionStream(event, response)`
-- [@intlify/h3](https://github.com/intlify/h3)
-  - `defineI18nMiddleware(options)`
-  - `useTranslation(event)`
-  - `getHeaderLocale(event, options)`
-  - `getHeaderLocales(event, options)`
-  - `getCookieLocale(event, options)`
-  - `setCookieLocale(event, options)`
-  - `getPathLocale(event, options)`
-  - `getQueryLocale(event, options)`
-
 ## License
 
 MIT

docs/.config/docs.yaml

@@ -0,0 +1,74 @@
+# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json
+name: h3
+shortDescription: The Web Framework for Modern JavaScript Era
+description:
+  H(TTP) server framework built for high performance and portability running
+  in any JavaScript runtime.
+github: unjs/h3
+url: https://h3.unjs.io
+automd: true
+redirects: {}
+landing:
+  heroLinks:
+    playOnline:
+      label: "Play Online"
+      icon: "i-simple-icons-lightning"
+      to: "https://stackblitz.com/github/unjs/h3/tree/main/playground"
+  contributors: true
+  featuresTitle: "The Web Framework for Modern JavaScript Era"
+  features:
+    # Runtime Agnostic
+    - title: "Runtime Agnostic"
+      description: "Your code will work on any JavaScript runtime including Node.js, Bun, Deno and Workers."
+      icon: "i-material-symbols-lock-open-right-outline-rounded"
+      to: ""
+      target: "_blank"
+
+    # Tree-shakable
+    - title: "Small and Tree-shakable"
+      description: "h3 core is super lightweight and tree-shakable, only what you use will be included in the the final bundle."
+      icon: "i-material-symbols-potted-plant-outline"
+      to: ""
+      target: "_blank"
+
+    # Composable
+    - title: "Composable"
+      description: "Expand your server and add capabilities. Your codebase will scale with your project."
+      icon: "i-fa-puzzle-piece"
+      to: ""
+      target: "_blank"
+
+    # Router
+    - title: "Fast Router"
+      description: "Super fast route matching using unjs/radix3"
+      icon: "i-fa-tree"
+      to: "https://github.com/unjs/radix3"
+      target: "_blank"
+
+    # Ecosystem
+    - title: "UnJS ecosystem"
+      description: "Built on top of powerful UnJS ecosystem powering Nitro, Nuxt and more frameworks!"
+      icon: "i-mdi-umbrella-outline"
+      to: "https://unjs.io"
+      target: "_blank"
+
+    # Made for Humans
+    - title: "Made for Humans"
+      description: "Elegant minimal API to implement HTTP handlers compatible with Web-Standards."
+      icon: "i-material-symbols-robot-2-sharp"
+      to: ""
+      target: "_blank"
+
+    # Compatibility
+    - title: "Compatible"
+      description: "Compatibility layer with node/connect/express middleware."
+      icon: "i-simple-icons-express"
+      to: ""
+      target: "_blank"
+
+    # Type Friendly
+    - title: "Type Friendly"
+      description: "Codebase fully written in TypeScript with strongly typed utils."
+      icon: "i-mdi-language-typescript"
+      to: ""
+      target: "_blank"