Skip to content

Commit 1b8e497

Browse files
authored
docs: convert to underscore preset names (#2592)
1 parent a8234d3 commit 1b8e497

6 files changed

Lines changed: 12 additions & 13 deletions

File tree

docs/1.guide/10.tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export default defineNuxtConfig({
9393
### Platform support
9494

9595
- `dev`, `node-server`, `bun` and `deno-server` presets are supported with [croner](https://croner.56k.guru/) engine.
96-
- `cloudflare_module` preset have native integraton with [Cron Triggers](https://developers.cloudflare.com/workers/configuration/cron-triggers/). Make sure to configure wrangler to use exactly same patterns you define in `scheduledTasks` to be matched.
96+
- `cloudflare_module` preset have native integration with [Cron Triggers](https://developers.cloudflare.com/workers/configuration/cron-triggers/). Make sure to configure wrangler to use exactly same patterns you define in `scheduledTasks` to be matched.
9797
- More presets (with native primitives support) are planned to be supported!
9898

9999
## Programmatically run tasks

docs/2.deploy/10.runtimes/1.node.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: akar-icons:node-fill
66

77
> Run Nitro apps with Node.js runtime.
88
9-
**Preset:** `node-server`
9+
**Preset:** `node_server`
1010

1111
Node.js is the default nitro output preset for production builds and Nitro has native Node.js runtime support.
1212

@@ -40,17 +40,16 @@ You can customize server behavior using following environment variables:
4040

4141
## Cluster mode
4242

43-
**Preset:** `node-cluster`
43+
**Preset:** `node_cluster`
4444

4545
For more performance and leveraging multi core handling, you can use cluster preset.
4646

4747
### Environment Variables
4848

49-
In addition to `node-server` environment variables, you can customize behavior:
49+
In addition to environment variables from the `node_server` preset, you can customize behavior:
5050

5151
- `NITRO_CLUSTER_WORKERS`: Number of cluster workers (default is Number of available cpu cores)
5252

53-
5453
## Handler (advanced)
5554

5655
**Preset:** `node`

docs/2.deploy/10.runtimes/deno.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ icon: simple-icons:deno
66

77
> Run Nitro apps with [Deno](https://deno.com/) runtime.
88
9-
**Preset:** `deno-server`
9+
**Preset:** `deno_server`
1010

1111
You can build your Nitro server using Node.js to run within [Deno Runtime](https://deno.com/runtime) in a custom server.
1212

1313
```bash
1414
# Build with the deno NITRO preset
15-
NITRO_PRESET=deno-server npm run build
15+
NITRO_PRESET=deno_server npm run build
1616

1717
# Start production server
1818
deno run --unstable --allow-net --allow-read --allow-env .output/server/index.ts

docs/2.deploy/20.providers/cloudflare.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ If you use the [Cloudflare Pages GitHub/GitLab integration](https://developers.c
2626

2727
If instead you want preview your application locally and/or manually deploy it, when building the application you will need to let Nitro know that the target environment is the Cloudflare Pages one, you can do that in two ways:
2828

29-
1. By defining either the `NITRO_PRESET` or the `SERVER_PRESET` environment variable set to `cloudflare-pages` when running the build process, like so:
29+
1. By defining either the `NITRO_PRESET` or the `SERVER_PRESET` environment variable set to `cloudflare_pages` when running the build process, like so:
3030

3131
```bash
32-
NITRO_PRESET=cloudflare-pages npm run build
32+
NITRO_PRESET=cloudflare_pages npm run build
3333
```
3434

3535
1. Or by updating your Nitro [preset configuration](/config#preset):
3636

3737
```json5
38-
"preset": "cloudflare-pages",
38+
"preset": "cloudflare_pages",
3939
```
4040

4141
and then running the standard build command:

docs/2.deploy/20.providers/digitalocean.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Deploy Nitro apps to DigitalOcean.
44
5-
**Preset:** `digital-ocean`
5+
**Preset:** `digital_ocean`
66

77
:read-more{title="Digital Ocean App Platform" to="https://docs.digitalocean.com/products/app-platform/"}
88

@@ -13,7 +13,7 @@
1313
1. Next, you'll need to configure environment variables. In your app settings, ensure the following app-level environment variables are set:
1414

1515
```bash
16-
NITRO_PRESET=digital-ocean
16+
NITRO_PRESET=digital_ocean
1717
```
1818

1919
[More information](https://docs.digitalocean.com/products/app-platform/how-to/use-environment-variables/).

docs/3.config/0.index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ icon: ri:settings-3-line
1212

1313
Use `preset` option `NITRO_PRESET` environment variable for custom **production** preset.
1414

15-
Preset for development mode is always `nitro-dev` and default `node-server` for production building a standalone Node.js server.
15+
Preset for development mode is always `nitro_dev` and default `node_server` for production building a standalone Node.js server.
1616

1717
The preset will automatically be detected when the `preset` option is not set and running in known environments.
1818

0 commit comments

Comments
 (0)