- 
-
-
-
diff --git a/docs/.docs/public/favicon.ico b/docs/.docs/public/favicon.ico
deleted file mode 100644
index 59886e68b8..0000000000
Binary files a/docs/.docs/public/favicon.ico and /dev/null differ
diff --git a/docs/.docs/public/icon.png b/docs/.docs/public/icon.png
deleted file mode 100644
index 190fa36848..0000000000
Binary files a/docs/.docs/public/icon.png and /dev/null differ
diff --git a/docs/.docs/public/nitro-dark.svg b/docs/.docs/public/nitro-dark.svg
deleted file mode 100644
index 28aea59c51..0000000000
--- a/docs/.docs/public/nitro-dark.svg
+++ /dev/null
@@ -1,38 +0,0 @@
-
diff --git a/docs/.docs/public/nitro-light.svg b/docs/.docs/public/nitro-light.svg
deleted file mode 100644
index 86f43f9b44..0000000000
--- a/docs/.docs/public/nitro-light.svg
+++ /dev/null
@@ -1,38 +0,0 @@
-
diff --git a/docs/1.guide/0.index.md b/docs/1.guide/0.index.md
index cfe762140d..06d135a522 100644
--- a/docs/1.guide/0.index.md
+++ b/docs/1.guide/0.index.md
@@ -72,7 +72,7 @@ The `routes/` directory contains your application handlers. You can create subdi
### `api/`
-The `api/` directory is similar to `routes/` with only difference that routes inside it will be prefixed with `/api/` for convenience.
+The `api/` directory is similar to `routes/` with the only difference that routes inside it will be prefixed with `/api/` for convenience.
:read-more{to="/guide/routing"}
diff --git a/docs/1.guide/1.utils.md b/docs/1.guide/1.utils.md
index 7a03f49c2f..e7fcbecd5b 100644
--- a/docs/1.guide/1.utils.md
+++ b/docs/1.guide/1.utils.md
@@ -58,8 +58,8 @@ Nitro also exposes several built-in utils:
- `nitroPlugin(plugin)`{lang=ts}
- `getRouteRules(event)`{lang=ts}
-::read-more{to="https://github.com/unjs/nitro/blob/main/src/imports.ts"}
-Check [the source code](https://github.com/unjs/nitro/blob/main/src/imports.ts) for list of available Nitro auto imports.
+::read-more{to="https://github.com/unjs/nitro/blob/v2/src/core/config/resolvers/imports.ts#L58"}
+Check [the source code](https://github.com/unjs/nitro/blob/v2/src/core/config/resolvers/imports.ts#L58) for list of available Nitro auto imports.
::
::read-more{to="/guide/typescript"}
diff --git a/docs/1.guide/10.tasks.md b/docs/1.guide/10.tasks.md
index 5ce12da6cf..a744ead52f 100644
--- a/docs/1.guide/10.tasks.md
+++ b/docs/1.guide/10.tasks.md
@@ -215,7 +215,7 @@ nitro task run db:migrate --payload "{}"
### Concurrency
-Each task can have **one running instance**. Calling a task of same name multiple times in parallel, results to calling it once and all callers will get the same return value.
+Each task can have **one running instance**. Calling a task of same name multiple times in parallel, results in calling it once and all callers will get the same return value.
> [!NOTE]
> Nitro tasks can be running multiple times and in parallel.
diff --git a/docs/1.guide/2.routing.md b/docs/1.guide/2.routing.md
index 74755f06d3..5adfbbe6e0 100644
--- a/docs/1.guide/2.routing.md
+++ b/docs/1.guide/2.routing.md
@@ -4,7 +4,7 @@ icon: ri:direction-line
# Server Routes
-> Nitro support filesystem routing to automatically map files to h3 routes.
+> Nitro supports filesystem routing to automatically map files to h3 routes.
## Event handlers
@@ -14,7 +14,7 @@ An [event handler](https://h3.unjs.io/guide/event-handler) is a function that wi
## Filesystem routing
-Nitro supports file-based routing for your API routes (file are automatically mapped to [h3 routes](https://h3.unjs.io/guide/router). Defining a route is as simple as creating a file inside the `api/` or `routes/` directory.
+Nitro supports file-based routing for your API routes (files are automatically mapped to [h3 routes](https://h3.unjs.io/guide/router)). Defining a route is as simple as creating a file inside the `api/` or `routes/` directory.
You can only define one handler per files and you can [append the HTTP method](#specific-request-method) to the filename to define a specific request method.
@@ -27,12 +27,26 @@ routes/
nitro.config.ts
```
+You can nest routes by creating subdirectories.
+
+```md
+routes/
+ communities/
+ index.get.ts
+ index.post.ts
+ [id]/
+ index.get.ts
+ index.post.ts
+ hello.get.ts
+ hello.post.ts
+```
+
::note
If you are using [Nuxt](https://nuxt.com), move the `server/api/` and `server/routes/` instead.
::
::tip
-Some providers like Vercel use a top-level `api/` directory as a feature, therefore routes placed in `/api` wont work.
+Some providers like Vercel use a top-level `api/` directory as a feature, therefore routes placed in `/api` won't work.
You will have to use `routes/api/`.
::
@@ -255,13 +269,21 @@ export default defineEventHandler((event) => {
})
```
+## Error handling
+
+You can use the [utilities available in H3](https://h3.unjs.io/guide/event-handler#error-handling) to handle errors in both routes and middlewares.
+
+The way errors are sent back to the client depends on the route's path. For most routes `Content-Type` is set to `text/html` by default and a simple html error page is delievered. If the route starts with `/api/` (either because it is placed in `api/` or `routes/api/`) the default will change to `application/json` and a JSON object will be sent.
+
+This behaviour can be overridden by some request properties (eg.: `Accept` or `User-Agent` headers).
+
## Route Rules
Nitro allows you to add logic at the top-level for each route of your configuration. It can be used for redirecting, proxying, caching and adding headers to routes.
It is a map from route pattern (following [unjs/radix3](https://github.com/unjs/radix3#route-matcher)) to route options.
-When `cache` option is set, handlers matching pattern will be automatically wrapped with `defineCachedEventHandler`. See the [guide cache](/guide/cache) to learn more about this function.
+When `cache` option is set, handlers matching pattern will be automatically wrapped with `defineCachedEventHandler`. See the [cache guide](/guide/cache) to learn more about this function.
::note
`swr: true|number` is shortcut for `cache: { swr: true, maxAge: number }`
diff --git a/docs/1.guide/3.websocket.md b/docs/1.guide/3.websocket.md
index 9e8eed1d6f..01d32359f1 100644
--- a/docs/1.guide/3.websocket.md
+++ b/docs/1.guide/3.websocket.md
@@ -4,7 +4,7 @@ icon: cib:socket-io
# WebSocket
-> Nitro natively support a cross platform WebSocket API
+> Nitro natively supports a cross platform WebSocket API
Nitro natively supports runtime agnostic [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) API using [CrossWS](https://crossws.unjs.io/) and [H3 WebSocket](https://h3.unjs.io/guide/websocket).
@@ -108,16 +108,16 @@ Create an SSE handler in `routes/sse.ts` (or `server/routes/sse.ts` for Nuxt).
```ts [sse.ts]
export default defineEventHandler(async (event) => {
const eventStream = createEventStream(event)
-
+
const interval = setInterval(async () => {
await eventStream.push(`Message @ ${new Date().toLocaleTimeString()}`)
}, 1000)
-
+
eventStream.onClosed(async () => {
clearInterval(interval)
await eventStream.close()
})
-
+
return eventStream.send()
})
```
@@ -126,7 +126,7 @@ Then connect to this SSE endpoint from the client
```ts
const eventSource = new EventSource('http://localhost:3000/sse')
-
+
eventSource.onmessage = (event) => {
console.log(event.data)
}
diff --git a/docs/1.guide/6.cache.md b/docs/1.guide/6.cache.md
index 825d6f99b6..2bf05f9a0d 100644
--- a/docs/1.guide/6.cache.md
+++ b/docs/1.guide/6.cache.md
@@ -59,7 +59,7 @@ export default defineEventHandler(async (event) => {
```
::
-The stars will be cached in development inside **.nitro/cache/functions/ghStars/<owner>/<repo>.json** with `value` being the number of stars.
+The stars will be cached in development inside ```.nitro/cache/functions/ghStars/{{ message.user }}
+{{ message.text }}
+{{ message.date }}
+