Repository navigation
Expand file tree
/
Copy pathnuxt.config.ts
More file actions
869 lines (860 loc) · 52.7 KB
/
Copy pathnuxt.config.ts
File metadata and controls
869 lines (860 loc) · 52.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
import { createResolver } from 'nuxt/kit'
import type { LLMsSection } from 'nuxt-llms'
import { agentHowToCall, agentWhenToUse } from './shared/utils/agents'
import { ARCHIVED_DOC_VERSIONS, CURRENT_DOCS_VERSION, NEXT_DOC_VERSIONS } from './shared/utils/docs'
import { MODULE_DOCS, MODULE_DOCS_NAMES, moduleDocsPathPrefix } from './shared/utils/module-docs'
const { resolve } = createResolver(import.meta.url)
const SITE_URL = 'https://nuxt.com'
// A preview's absolute URLs (social images, raw markdown links) point at the preview itself, so a shared link unfurls.
const PREVIEW_URL = process.env.VERCEL_ENV === 'preview' && process.env.VERCEL_BRANCH_URL
? `https://${process.env.VERCEL_BRANCH_URL}`
: undefined
// In `--ui-only` mode (default `pnpm dev`), skip the `eve/nuxt` module so the
// Eve agent runtime is never spawned locally. The UI and server routes from
// `layers/nuxi` are still loaded — only the agent itself is disabled.
// `--with-nuxi` (`pnpm dev:nuxi`) re-enables the agent while keeping ui-only proxies.
/**
* Revalidation window for content pages and indexes.
*
* How long a *missed* webhook delivery can serve stale content.
*/
const CONTENT_ISR = 300
const uiOnly = process.argv.includes('--ui-only')
const withNuxi = process.argv.includes('--with-nuxi')
const nuxiEnabled = !uiOnly || withNuxi
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
extends: ['./layers/nuxi'],
modules: [
'@nuxt/ui',
'@nuxt/test-utils',
'@comark/nuxt',
'@nuxt/image',
'@nuxt/eslint',
'@nuxt/scripts',
'@vueuse/nuxt',
'nuxt-og-image',
'motion-v/nuxt',
'nuxt-llms',
'@nuxthub/core',
'nuxt-auth-utils',
'nuxt-schema-org',
'@nuxtjs/mcp-toolkit',
'@nuxtjs/robots',
'@nuxtjs/sitemap',
'nuxt-agent-discovery',
'@nuxt/hints',
'@vercel/analytics',
'@vercel/speed-insights',
'evlog/nuxt',
'nuxt-workers',
'workflow/nuxt',
...(nuxiEnabled ? ['eve/nuxt'] : [])
],
$development: {
site: {
url: 'http://localhost:3000'
},
image: {
alias: {
'/gh/': 'https://raw.githubusercontent.com',
'/gh_avatar/': 'https://avatars.githubusercontent.com'
},
domains: [
'raw.githubusercontent.com',
'avatars.githubusercontent.com',
'nuxt.com'
]
}
},
$production: {
hub: {
kv: {
driver: 'vercel-runtime-cache'
}
},
image: {
ipx: {
baseURL: 'https://ipx.nuxt.com'
}
}
},
components: [
// Keeps `@nuxt/content` names (`ReadMore`, not `ContentReadMore`).
// Pages pass them to `MarkdownDocument` through `components`.
{ path: '~/components/content', pathPrefix: false },
// Nuxt's defaults, which an explicit list replaces.
{ path: '~/components/global', global: true },
'~/components'
],
devtools: {
enabled: true
},
app: {
pageTransition: false,
layoutTransition: false
},
css: ['~/assets/css/main.css'],
site: {
name: 'Nuxt',
url: PREVIEW_URL ?? SITE_URL,
description: 'Build fast, production-ready web apps with Vue. File-based routing, auto-imports, and server-side rendering — all configured out of the box.',
defaultLocale: 'en'
},
colorMode: {
preference: 'dark'
},
ui: {
theme: {
colors: ['primary', 'secondary', 'info', 'success', 'warning', 'error', 'important']
},
experimental: {
componentDetection: true
},
prose: true,
content: true
},
runtimeConfig: {
public: {
eveEnabled: nuxiEnabled,
// Nuxt UI prose headings read this MDC setting to render anchor links, which comark doesn't set.
mdc: {
headings: {
anchorLinks: { h2: true, h3: true, h4: true }
}
}
},
mcpAdminToken: '',
// Service account added as a user of the Search Console property (admin MCP `search-console-*` tools)
googleSearchConsole: {
clientEmail: '',
privateKey: '',
siteUrl: 'sc-domain:nuxt.com'
},
// Google Cloud API key with the Chrome UX Report API enabled (admin MCP `crux-web-vitals` tool)
googleCrux: {
apiKey: ''
},
github: {
token: ''
},
linear: {
apiKey: '',
teamId: 'f79ad145-d4eb-4bff-88b9-c344f006a777',
projectId: '11a6000e-6c95-445e-85f1-a7de5c372bcd'
},
newsletter: {
secret: ''
},
webhookSecret: '',
resend: {
apiKey: '',
audienceId: ''
},
// Discord role unlock on /nuxters. Off unless the guild, bot token and
// `NUXT_OAUTH_DISCORD_CLIENT_ID`/`_SECRET` are all set. `nuxtersDiscord.config()` also reads
// the `NUXT_DISCORD_*` names of the Vercel project at runtime.
nuxters: {
// Secret of the nuxt/nuxters push webhook (POST /api/webhooks/nuxters)
webhookSecret: '',
discord: {
guildId: '',
botToken: '',
roles: {
nuxter: '',
moduleAuthor: '',
// One key per hackathon id in `NUXTERS_HACKATHONS`
nuxtathon1: '',
nuxtathon2: ''
}
}
}
},
routeRules: {
// Content pages are ISR: rendered on demand, then served from the CDN until the push webhook purges them.
// Cached patterns negotiate by redirecting agents to the raw twin (nuxt-agent-discovery).
'/': { isr: CONTENT_ISR },
'/llms.txt': { isr: CONTENT_ISR, prerender: false },
'/llms-full.txt': { isr: CONTENT_ISR, prerender: false },
'/blog/rss.xml': { isr: CONTENT_ISR },
'/sitemap.xml': { isr: CONTENT_ISR },
'/sitemap.md': { isr: CONTENT_ISR },
'/design.md': { isr: CONTENT_ISR, robots: 'noindex' },
'/openapi.json': { isr: CONTENT_ISR },
'/nuxt-brand-assets.zip': { prerender: true },
// The listing is filtered from the query: without `allowQuery`, Vercel serves the unfiltered
// cached page for every `?category=` and hydration mismatches. Other query params (utm_*) are ignored.
'/modules': { isr: { expiration: 60 * 60, allowQuery: ['category', 'q', 'sortBy', 'orderBy'], passQuery: true }, prerender: false },
'/modules/**': { isr: 60 * 60 },
'/changelog': { isr: 60 * 60 },
// Lists blog posts and GitHub releases: purged on content push, refreshed hourly for releases.
'/updates': { isr: 60 * 60 },
'/docs/**': { isr: CONTENT_ISR },
'/blog': { redirect: { to: '/updates', statusCode: 301 } },
'/blog/**': { isr: CONTENT_ISR },
'/deploy': { isr: CONTENT_ISR },
'/deploy/**': { isr: CONTENT_ISR },
'/raw/**': { isr: CONTENT_ISR, robots: 'noindex' },
'/enterprise/**': { isr: CONTENT_ISR },
'/templates': { isr: CONTENT_ISR },
'/showcase': { isr: CONTENT_ISR },
'/team': { isr: CONTENT_ISR },
'/design-kit': { isr: CONTENT_ISR },
'/video-courses': { isr: CONTENT_ISR },
'/newsletter': { isr: CONTENT_ISR },
// Stats change once a day (nuxt/nuxters CI); the import purges /nuxters itself.
// One cache entry per `?period=` and `?country=` (and only those: no entry per utm_* link).
'/nuxters': { isr: { expiration: 60 * 60, allowQuery: ['period', 'country'], passQuery: true } },
// Profiles too: `?period=` selects the stats on screen.
'/nuxters/**': { isr: { expiration: 60 * 60, allowQuery: ['period'], passQuery: true } },
// API
'/api/v1/teams': { isr: 60 * 60 },
// Admin
'/admin': { ssr: false },
'/admin/**': { ssr: false },
'/admin/login': { redirect: '/login?redirect=/admin', prerender: false },
// Auth-protected client-side area — never SSR'd.
'/dashboard': { ssr: false },
'/dashboard/**': { ssr: false },
'/_eve_internal/**': { headers: { 'cache-control': 'no-store' } },
'/api/internal/**': { headers: { 'cache-control': 'no-store' } },
// Static image: nothing in it should ever run, even when opened directly
// TODO: remove once @nuxtjs/mcp-toolkit ships nuxt-modules/mcp-toolkit#387, which sends this header itself
'/mcp/badge.svg': { headers: { 'content-security-policy': 'default-src \'none\'; style-src \'unsafe-inline\'; sandbox' } },
// Main navigation
'/api/navigation/**': { isr: CONTENT_ISR },
'/api/content/blob/**': { isr: true },
'/api/content/pull/*/*/blob/**': { isr: true },
'/pull/**': { isr: CONTENT_ISR, robots: 'noindex, nofollow' },
// Redirects
'/docs': { redirect: '/docs/getting-started/introduction', prerender: false },
'/docs/2.x': { redirect: '/docs/2.x/getting-started/installation', prerender: false },
'/docs/2.x/getting-started': { redirect: '/docs/2.x/getting-started/installation', prerender: false },
'/docs/2.x/directory-structure': { redirect: '/docs/2.x/directory-structure/nuxt', prerender: false },
'/docs/2.x/guide': { redirect: '/docs/2.x/guide/concepts/views', prerender: false },
'/docs/2.x/guide/concepts': { redirect: '/docs/2.x/guide/concepts/views', prerender: false },
'/docs/2.x/api': { redirect: '/docs/2.x/api/configuration/configuration-alias', prerender: false },
'/docs/2.x/api/configuration': { redirect: '/docs/2.x/api/configuration/configuration-alias', prerender: false },
'/docs/2.x/api/internals': { redirect: '/docs/2.x/api/internals/context', prerender: false },
'/docs/2.x/api/components': { redirect: '/docs/2.x/api/components/fetch', prerender: false },
'/docs/3.x': { redirect: '/docs/3.x/getting-started/introduction', prerender: false },
'/docs/4.x': { redirect: '/docs/4.x/getting-started/introduction', prerender: false },
'/docs/5.x': { redirect: '/docs/5.x/getting-started/introduction', prerender: false },
'/docs/getting-started': { redirect: '/docs/getting-started/introduction', prerender: false },
'/docs/3.x/getting-started': { redirect: '/docs/3.x/getting-started/introduction', prerender: false },
'/docs/4.x/getting-started': { redirect: '/docs/4.x/getting-started/introduction', prerender: false },
'/docs/5.x/getting-started': { redirect: '/docs/5.x/getting-started/introduction', prerender: false },
'/docs/guide/concepts': { redirect: '/docs/guide/concepts/auto-imports', prerender: false },
'/docs/3.x/guide/concepts': { redirect: '/docs/3.x/guide/concepts/auto-imports', prerender: false },
'/docs/4.x/guide/concepts': { redirect: '/docs/4.x/guide/concepts/auto-imports', prerender: false },
'/docs/5.x/guide/concepts': { redirect: '/docs/5.x/guide/concepts/auto-imports', prerender: false },
'/docs/guide/directory-structure': { redirect: '/docs/directory-structure', prerender: false },
'/docs/3.x/guide/directory-structure': { redirect: '/docs/3.x/directory-structure', prerender: false },
'/docs/4.x/guide/directory-structure': { redirect: '/docs/4.x/directory-structure', prerender: false },
'/docs/5.x/guide/directory-structure': { redirect: '/docs/5.x/directory-structure', prerender: false },
'/docs/guide/going-further': { redirect: '/docs/guide/going-further/experimental-features', prerender: false },
'/docs/3.x/guide/going-further': { redirect: '/docs/3.x/guide/going-further/experimental-features', prerender: false },
'/docs/4.x/guide/going-further': { redirect: '/docs/4.x/guide/going-further/experimental-features', prerender: false },
'/docs/5.x/guide/going-further': { redirect: '/docs/5.x/guide/going-further/experimental-features', prerender: false },
'/docs/guide/going-further/edge-release-channel': { redirect: '/docs/guide/going-further/nightly-release-channel', prerender: false },
'/docs/3.x/guide/going-further/edge-release-channel': { redirect: '/docs/3.x/guide/going-further/nightly-release-channel', prerender: false },
'/docs/4.x/guide/going-further/edge-release-channel': { redirect: '/docs/4.x/guide/going-further/nightly-release-channel', prerender: false },
'/docs/5.x/guide/going-further/edge-release-channel': { redirect: '/docs/5.x/guide/going-further/nightly-release-channel', prerender: false },
'/docs/bridge': { redirect: '/docs/bridge/overview', prerender: false },
'/docs/3.x/bridge': { redirect: '/docs/3.x/bridge/overview', prerender: false },
'/docs/4.x/bridge': { redirect: '/docs/4.x/bridge/overview', prerender: false },
'/docs/5.x/bridge': { redirect: '/docs/5.x/bridge/overview', prerender: false },
'/docs/migration': { redirect: '/docs/migration/overview', prerender: false },
'/docs/3.x/migration': { redirect: '/docs/3.x/migration/overview', prerender: false },
'/docs/4.x/migration': { redirect: '/docs/4.x/migration/overview', prerender: false },
'/docs/5.x/migration': { redirect: '/docs/5.x/migration/overview', prerender: false },
'/docs/api/components': { redirect: '/docs/api/components/client-only', prerender: false },
'/docs/3.x/api/components': { redirect: '/docs/3.x/api/components/client-only', prerender: false },
'/docs/4.x/api/components': { redirect: '/docs/4.x/api/components/client-only', prerender: false },
'/docs/5.x/api/components': { redirect: '/docs/5.x/api/components/client-only', prerender: false },
'/docs/api/composables': { redirect: '/docs/api/composables/use-app-config', prerender: false },
'/docs/3.x/api/composables': { redirect: '/docs/3.x/api/composables/use-app-config', prerender: false },
'/docs/4.x/api/composables': { redirect: '/docs/4.x/api/composables/use-app-config', prerender: false },
'/docs/5.x/api/composables': { redirect: '/docs/5.x/api/composables/use-app-config', prerender: false },
'/docs/api/utils': { redirect: '/docs/api/utils/dollarfetch', prerender: false },
'/docs/3.x/api/utils': { redirect: '/docs/3.x/api/utils/dollarfetch', prerender: false },
'/docs/4.x/api/utils': { redirect: '/docs/4.x/api/utils/dollarfetch', prerender: false },
'/docs/5.x/api/utils': { redirect: '/docs/5.x/api/utils/dollarfetch', prerender: false },
'/docs/api/kit': { redirect: '/docs/api/kit/modules', prerender: false },
'/docs/3.x/api/kit': { redirect: '/docs/3.x/api/kit/modules', prerender: false },
'/docs/4.x/api/kit': { redirect: '/docs/4.x/api/kit/modules', prerender: false },
'/docs/5.x/api/kit': { redirect: '/docs/5.x/api/kit/modules', prerender: false },
'/docs/api/commands': { redirect: '/docs/api/commands/overview', prerender: false },
'/docs/3.x/api/commands': { redirect: '/docs/3.x/api/commands/overview', prerender: false },
'/docs/4.x/api/commands': { redirect: '/docs/4.x/api/commands/overview', prerender: false },
'/docs/5.x/api/commands': { redirect: '/docs/5.x/api/commands/overview', prerender: false },
'/docs/api/advanced': { redirect: '/docs/api/advanced/hooks', prerender: false },
'/docs/3.x/api/advanced': { redirect: '/docs/3.x/api/advanced/hooks', prerender: false },
'/docs/4.x/api/advanced': { redirect: '/docs/4.x/api/advanced/hooks', prerender: false },
'/docs/5.x/api/advanced': { redirect: '/docs/5.x/api/advanced/hooks', prerender: false },
'/docs/api/configuration/nuxt-config': { redirect: '/docs/api/nuxt-config', prerender: false },
'/docs/3.x/api/configuration/nuxt-config': { redirect: '/docs/3.x/api/nuxt-config', prerender: false },
'/docs/4.x/api/configuration/nuxt-config': { redirect: '/docs/4.x/api/nuxt-config', prerender: false },
'/docs/5.x/api/configuration/nuxt-config': { redirect: '/docs/5.x/api/nuxt-config', prerender: false },
// New during comark migration:
// Move examples at one canonical unversioned path since they're not versionned
'/docs/3.x/examples/**': { redirect: { to: '/docs/examples/**', statusCode: 301 }, prerender: false },
'/docs/4.x/examples/**': { redirect: { to: '/docs/examples/**', statusCode: 301 }, prerender: false },
'/docs/5.x/examples/**': { redirect: { to: '/docs/examples/**', statusCode: 301 }, prerender: false },
'/docs/3.x/examples': { redirect: { to: '/docs/examples/hello-world', statusCode: 301 }, prerender: false },
'/docs/4.x/examples': { redirect: { to: '/docs/examples/hello-world', statusCode: 301 }, prerender: false },
'/docs/5.x/examples': { redirect: { to: '/docs/examples/hello-world', statusCode: 301 }, prerender: false },
'/docs/examples': { redirect: '/docs/examples/hello-world', prerender: false },
'/docs/examples/features': { redirect: '/docs/examples/features/auto-imports', prerender: false },
'/docs/examples/routing': { redirect: '/docs/examples/routing/middleware', prerender: false },
'/docs/examples/advanced': { redirect: '/docs/examples/advanced/config-extends', prerender: false },
'/docs/examples/experimental': { redirect: '/docs/examples/experimental/wasm', prerender: false },
'/docs/community': { redirect: '/docs/community/getting-help', prerender: false },
'/docs/3.x/community': { redirect: '/docs/3.x/community/getting-help', prerender: false },
'/docs/4.x/community': { redirect: '/docs/4.x/community/getting-help', prerender: false },
'/docs/5.x/community': { redirect: '/docs/5.x/community/getting-help', prerender: false },
'/docs/community/nuxt-community': { redirect: '/docs/community/getting-help', prerender: false },
'/docs/3.x/community/nuxt-community': { redirect: '/docs/3.x/community/getting-help', prerender: false },
'/docs/4.x/community/nuxt-community': { redirect: '/docs/4.x/community/getting-help', prerender: false },
'/docs/5.x/community/nuxt-community': { redirect: '/docs/5.x/community/getting-help', prerender: false },
'/docs/guide/recipes': { redirect: '/docs/guide/recipes/custom-routing', prerender: false },
'/docs/3.x/guide/recipes': { redirect: '/docs/3.x/guide/recipes/custom-routing', prerender: false },
'/docs/4.x/guide/recipes': { redirect: '/docs/4.x/guide/recipes/custom-routing', prerender: false },
'/docs/5.x/guide/recipes': { redirect: '/docs/5.x/guide/recipes/custom-routing', prerender: false },
'/docs/guide/best-practices': { redirect: '/docs/guide/best-practices/performance', prerender: false },
'/docs/3.x/guide/best-practices': { redirect: '/docs/3.x/guide/best-practices/performance', prerender: false },
'/docs/4.x/guide/best-practices': { redirect: '/docs/4.x/guide/best-practices/performance', prerender: false },
'/docs/5.x/guide/best-practices': { redirect: '/docs/5.x/guide/best-practices/performance', prerender: false },
'/docs/guide/concepts/modules': { redirect: '/docs/guide/modules/getting-started', prerender: false },
'/docs/3.x/guide/concepts/modules': { redirect: '/docs/3.x/guide/modules/getting-started', prerender: false },
'/docs/4.x/guide/concepts/modules': { redirect: '/docs/4.x/guide/modules/getting-started', prerender: false },
'/docs/5.x/guide/concepts/modules': { redirect: '/docs/5.x/guide/modules/getting-started', prerender: false },
'/docs/guide/going-further/custom-routing': { redirect: '/docs/guide/recipes/custom-routing', prerender: false },
'/docs/3.x/guide/going-further/custom-routing': { redirect: '/docs/3.x/guide/recipes/custom-routing', prerender: false },
'/docs/4.x/guide/going-further/custom-routing': { redirect: '/docs/4.x/guide/recipes/custom-routing', prerender: false },
'/docs/5.x/guide/going-further/custom-routing': { redirect: '/docs/5.x/guide/recipes/custom-routing', prerender: false },
// new directory structure
'/docs/3.x/directory-structure/app/assets': { redirect: '/docs/3.x/directory-structure/assets', prerender: false },
'/docs/3.x/directory-structure/app/components': { redirect: '/docs/3.x/directory-structure/components', prerender: false },
'/docs/3.x/directory-structure/app/composables': { redirect: '/docs/3.x/directory-structure/composables', prerender: false },
'/docs/3.x/directory-structure/app/error': { redirect: '/docs/3.x/directory-structure/error', prerender: false },
'/docs/3.x/directory-structure/app/layouts': { redirect: '/docs/3.x/directory-structure/layouts', prerender: false },
'/docs/3.x/directory-structure/app/middleware': { redirect: '/docs/3.x/directory-structure/middleware', prerender: false },
'/docs/3.x/directory-structure/app/pages': { redirect: '/docs/3.x/directory-structure/pages', prerender: false },
'/docs/3.x/directory-structure/app/plugins': { redirect: '/docs/3.x/directory-structure/plugins', prerender: false },
'/docs/3.x/directory-structure/app/utils': { redirect: '/docs/3.x/directory-structure/utils', prerender: false },
'/docs/4.x/directory-structure/app': { redirect: '/docs/4.x/directory-structure/app/app', prerender: false },
'/docs/5.x/directory-structure/app': { redirect: '/docs/4.x/directory-structure/app/app', prerender: false },
'/docs/3.x/guide/directory-structure/**': { redirect: '/docs/3.x/directory-structure', prerender: false },
'/docs/3.x/guide/directory-structure/app/assets': { redirect: '/docs/3.x/directory-structure/assets', prerender: false },
'/docs/4.x/guide/directory-structure/assets': { redirect: '/docs/4.x/directory-structure/app/assets', prerender: false },
'/docs/5.x/guide/directory-structure/assets': { redirect: '/docs/4.x/directory-structure/app/assets', prerender: false },
'/docs/3.x/guide/directory-structure/app/components': { redirect: '/docs/3.x/directory-structure/components', prerender: false },
'/docs/4.x/guide/directory-structure/components': { redirect: '/docs/4.x/directory-structure/app/components', prerender: false },
'/docs/5.x/guide/directory-structure/components': { redirect: '/docs/4.x/directory-structure/app/components', prerender: false },
'/docs/3.x/guide/directory-structure/app/composables': { redirect: '/docs/3.x/directory-structure/composables', prerender: false },
'/docs/4.x/guide/directory-structure/composables': { redirect: '/docs/4.x/directory-structure/app/composables', prerender: false },
'/docs/5.x/guide/directory-structure/composables': { redirect: '/docs/4.x/directory-structure/app/composables', prerender: false },
'/docs/3.x/guide/directory-structure/app/layouts': { redirect: '/docs/3.x/directory-structure/layouts', prerender: false },
'/docs/4.x/guide/directory-structure/layouts': { redirect: '/docs/4.x/directory-structure/app/layouts', prerender: false },
'/docs/5.x/guide/directory-structure/layouts': { redirect: '/docs/4.x/directory-structure/app/layouts', prerender: false },
'/docs/3.x/guide/directory-structure/app/middleware': { redirect: '/docs/3.x/directory-structure/middleware', prerender: false },
'/docs/4.x/guide/directory-structure/middleware': { redirect: '/docs/4.x/directory-structure/app/middleware', prerender: false },
'/docs/5.x/guide/directory-structure/middleware': { redirect: '/docs/4.x/directory-structure/app/middleware', prerender: false },
'/docs/3.x/guide/directory-structure/app/pages': { redirect: '/docs/3.x/directory-structure/pages', prerender: false },
'/docs/4.x/guide/directory-structure/pages': { redirect: '/docs/4.x/directory-structure/app/pages', prerender: false },
'/docs/5.x/guide/directory-structure/pages': { redirect: '/docs/4.x/directory-structure/app/pages', prerender: false },
'/docs/3.x/guide/directory-structure/app/plugins': { redirect: '/docs/3.x/directory-structure/plugins', prerender: false },
'/docs/4.x/guide/directory-structure/plugins': { redirect: '/docs/4.x/directory-structure/app/plugins', prerender: false },
'/docs/5.x/guide/directory-structure/plugins': { redirect: '/docs/4.x/directory-structure/app/plugins', prerender: false },
'/docs/3.x/guide/directory-structure/app/utils': { redirect: '/docs/3.x/directory-structure/utils', prerender: false },
'/docs/4.x/guide/directory-structure/utils': { redirect: '/docs/4.x/directory-structure/app/utils', prerender: false },
'/docs/5.x/guide/directory-structure/utils': { redirect: '/docs/4.x/directory-structure/app/utils', prerender: false },
'/docs/4.x/guide/directory-structure/app': { redirect: '/docs/4.x/directory-structure/app/app', prerender: false },
'/docs/5.x/guide/directory-structure/app': { redirect: '/docs/4.x/directory-structure/app/app', prerender: false },
'/docs/3.x/guide/directory-structure-config/app': { redirect: '/docs/3.x/directory-structure/app-config', prerender: false },
'/docs/4.x/guide/guide/directory-structure/app-config': { redirect: '/docs/4.x/directory-structure/app/app-config', prerender: false },
'/docs/5.x/guide/guide/directory-structure/app-config': { redirect: '/docs/4.x/directory-structure/app/app-config', prerender: false },
'/docs/3.x/guide/directory-structure/app/error': { redirect: '/docs/3.x/directory-structure/error', prerender: false },
'/docs/4.x/guide/directory-structure/error': { redirect: '/docs/4.x/directory-structure/app/error', prerender: false },
'/docs/5.x/guide/directory-structure/error': { redirect: '/docs/4.x/directory-structure/app/error', prerender: false },
// old directory structure in guide
'/docs/4.x/guide/directory-structure/nuxt': { redirect: '/docs/4.x/directory-structure/nuxt', prerender: false },
'/docs/5.x/guide/directory-structure/nuxt': { redirect: '/docs/4.x/directory-structure/nuxt', prerender: false },
'/docs/4.x/guide/directory-structure/output': { redirect: '/docs/4.x/directory-structure/output', prerender: false },
'/docs/5.x/guide/directory-structure/output': { redirect: '/docs/4.x/directory-structure/output', prerender: false },
'/docs/4.x/guide/directory-structure/app/assets': { redirect: '/docs/4.x/directory-structure/app/assets', prerender: false },
'/docs/5.x/guide/directory-structure/app/assets': { redirect: '/docs/4.x/directory-structure/app/assets', prerender: false },
'/docs/4.x/guide/directory-structure/app/components': { redirect: '/docs/4.x/directory-structure/app/components', prerender: false },
'/docs/5.x/guide/directory-structure/app/components': { redirect: '/docs/4.x/directory-structure/app/components', prerender: false },
'/docs/4.x/guide/directory-structure/app/composables': { redirect: '/docs/4.x/directory-structure/app/composables', prerender: false },
'/docs/5.x/guide/directory-structure/app/composables': { redirect: '/docs/4.x/directory-structure/app/composables', prerender: false },
'/docs/4.x/guide/directory-structure/app/layouts': { redirect: '/docs/4.x/directory-structure/app/layouts', prerender: false },
'/docs/5.x/guide/directory-structure/app/layouts': { redirect: '/docs/4.x/directory-structure/app/layouts', prerender: false },
'/docs/4.x/guide/directory-structure/app/middleware': { redirect: '/docs/4.x/directory-structure/app/middleware', prerender: false },
'/docs/5.x/guide/directory-structure/app/middleware': { redirect: '/docs/4.x/directory-structure/app/middleware', prerender: false },
'/docs/4.x/guide/directory-structure/app/pages': { redirect: '/docs/4.x/directory-structure/app/pages', prerender: false },
'/docs/5.x/guide/directory-structure/app/pages': { redirect: '/docs/4.x/directory-structure/app/pages', prerender: false },
'/docs/4.x/guide/directory-structure/app/plugins': { redirect: '/docs/4.x/directory-structure/app/plugins', prerender: false },
'/docs/5.x/guide/directory-structure/app/plugins': { redirect: '/docs/4.x/directory-structure/app/plugins', prerender: false },
'/docs/4.x/guide/directory-structure/app/utils': { redirect: '/docs/4.x/directory-structure/app/utils', prerender: false },
'/docs/5.x/guide/directory-structure/app/utils': { redirect: '/docs/4.x/directory-structure/app/utils', prerender: false },
'/docs/4.x/guide/directory-structure/app/app': { redirect: '/docs/4.x/directory-structure/app/app', prerender: false },
'/docs/5.x/guide/directory-structure/app/app': { redirect: '/docs/4.x/directory-structure/app/app', prerender: false },
'/docs/4.x/guide/directory-structure/app/app-config': { redirect: '/docs/4.x/directory-structure/app/app-config', prerender: false },
'/docs/5.x/guide/directory-structure/app/app-config': { redirect: '/docs/4.x/directory-structure/app/app-config', prerender: false },
'/docs/4.x/guide/directory-structure/app/error': { redirect: '/docs/4.x/directory-structure/app/error', prerender: false },
'/docs/5.x/guide/directory-structure/app/error': { redirect: '/docs/4.x/directory-structure/app/error', prerender: false },
'/docs/4.x/guide/directory-structure/content': { redirect: '/docs/4.x/directory-structure/content', prerender: false },
'/docs/5.x/guide/directory-structure/content': { redirect: '/docs/4.x/directory-structure/content', prerender: false },
'/docs/4.x/guide/directory-structure/modules': { redirect: '/docs/4.x/directory-structure/modules', prerender: false },
'/docs/5.x/guide/directory-structure/modules': { redirect: '/docs/4.x/directory-structure/modules', prerender: false },
'/docs/4.x/guide/directory-structure/node_modules': { redirect: '/docs/4.x/directory-structure/node_modules', prerender: false },
'/docs/5.x/guide/directory-structure/node_modules': { redirect: '/docs/4.x/directory-structure/node_modules', prerender: false },
'/docs/4.x/guide/directory-structure/public': { redirect: '/docs/4.x/directory-structure/public', prerender: false },
'/docs/5.x/guide/directory-structure/public': { redirect: '/docs/4.x/directory-structure/public', prerender: false },
'/docs/4.x/guide/directory-structure/server': { redirect: '/docs/4.x/directory-structure/server', prerender: false },
'/docs/5.x/guide/directory-structure/server': { redirect: '/docs/4.x/directory-structure/server', prerender: false },
'/docs/4.x/guide/directory-structure/shared': { redirect: '/docs/4.x/directory-structure/shared', prerender: false },
'/docs/5.x/guide/directory-structure/shared': { redirect: '/docs/4.x/directory-structure/shared', prerender: false },
'/docs/4.x/guide/directory-structure/env': { redirect: '/docs/4.x/directory-structure/env', prerender: false },
'/docs/5.x/guide/directory-structure/env': { redirect: '/docs/4.x/directory-structure/env', prerender: false },
'/docs/4.x/guide/directory-structure/gitignore': { redirect: '/docs/4.x/directory-structure/gitignore', prerender: false },
'/docs/5.x/guide/directory-structure/gitignore': { redirect: '/docs/4.x/directory-structure/gitignore', prerender: false },
'/docs/4.x/guide/directory-structure/nuxtignore': { redirect: '/docs/4.x/directory-structure/nuxtignore', prerender: false },
'/docs/5.x/guide/directory-structure/nuxtignore': { redirect: '/docs/4.x/directory-structure/nuxtignore', prerender: false },
'/docs/4.x/guide/directory-structure/nuxtrc': { redirect: '/docs/4.x/directory-structure/nuxtrc', prerender: false },
'/docs/5.x/guide/directory-structure/nuxtrc': { redirect: '/docs/4.x/directory-structure/nuxtrc', prerender: false },
'/docs/4.x/guide/directory-structure/nuxt-config': { redirect: '/docs/4.x/directory-structure/nuxt-config', prerender: false },
'/docs/5.x/guide/directory-structure/nuxt-config': { redirect: '/docs/4.x/directory-structure/nuxt-config', prerender: false },
'/docs/4.x/guide/directory-structure/package': { redirect: '/docs/4.x/directory-structure/package', prerender: false },
'/docs/5.x/guide/directory-structure/package': { redirect: '/docs/4.x/directory-structure/package', prerender: false },
'/docs/4.x/guide/directory-structure/tsconfig': { redirect: '/docs/4.x/directory-structure/tsconfig', prerender: false },
'/docs/5.x/guide/directory-structure/tsconfig': { redirect: '/docs/4.x/directory-structure/tsconfig', prerender: false },
// '/docs/guide/directory-structure/nuxt.config': { redirect: '/docs/guide/directory-structure/nuxt-config', prerender: false },
'/enterprise': { redirect: '/enterprise/agencies', prerender: false },
'/enterprise/support': { redirect: '/enterprise/agencies', prerender: false },
'/support/us': { redirect: '/sponsors', prerender: false },
'/enterprise/sponsors': { redirect: { to: '/sponsors', statusCode: 301 }, prerender: false },
'/docs/4.x/guide/ai': { redirect: '/docs/4.x/guide/ai/mcp', prerender: false },
'/docs/5.x/guide/ai': { redirect: '/docs/5.x/guide/ai/mcp', prerender: false },
'/docs/3.x/guide/ai': { redirect: '/docs/4.x/guide/ai/mcp', prerender: false },
// showcase assets
'/assets/websites/12go.png': { redirect: '/assets/websites/12go.webp' },
'/assets/websites/git-lab.png': { redirect: '/assets/websites/git-lab.webp' },
'/assets/websites/mc-donalds-france.png': { redirect: '/assets/websites/mc-donalds-france.webp' },
'/assets/websites/stack-overflow.png': { redirect: '/assets/websites/stack-overflow.webp' },
'/assets/websites/armani.png': { redirect: '/assets/websites/armani.webp' },
'/assets/websites/google-ventures.png': { redirect: '/assets/websites/google-ventures.webp' },
'/assets/websites/microsoft-edge-developer.png': { redirect: '/assets/websites/microsoft-edge-developer.webp' },
'/assets/websites/the-north-face.png': { redirect: '/assets/websites/the-north-face.webp' },
'/assets/websites/buy-mea-coffee.png': { redirect: '/assets/websites/buy-mea-coffee.webp' },
'/assets/websites/hai.png': { redirect: '/assets/websites/hai.webp' },
'/assets/websites/n8n.png': { redirect: '/assets/websites/n8n.webp' },
'/assets/websites/tiktok-ads.png': { redirect: '/assets/websites/tiktok-ads.webp' },
'/assets/websites/caudalie.png': { redirect: '/assets/websites/caudalie.webp' },
'/assets/websites/harrods.png': { redirect: '/assets/websites/harrods.webp' },
'/assets/websites/nasa-jet-propulsion-laboratory.png': { redirect: '/assets/websites/nasa-jet-propulsion-laboratory.webp' },
'/assets/websites/timberland.png': { redirect: '/assets/websites/timberland.webp' },
'/assets/websites/clean-shot-x.png': { redirect: '/assets/websites/clean-shot-x.webp' },
'/assets/websites/hostel-world.png': { redirect: '/assets/websites/hostel-world.webp' },
'/assets/websites/on-running.png': { redirect: '/assets/websites/on-running.webp' },
'/assets/websites/too-good-to-go.png': { redirect: '/assets/websites/too-good-to-go.webp' },
'/assets/websites/croix-rouge.png': { redirect: '/assets/websites/croix-rouge.webp' },
'/assets/websites/hostinger.png': { redirect: '/assets/websites/hostinger.webp' },
'/assets/websites/paul-smith.png': { redirect: '/assets/websites/paul-smith.webp' },
'/assets/websites/toolstation.png': { redirect: '/assets/websites/toolstation.webp' },
'/assets/websites/delvaux.png': { redirect: '/assets/websites/delvaux.webp' },
'/assets/websites/icons8.png': { redirect: '/assets/websites/icons8.webp' },
'/assets/websites/promod.png': { redirect: '/assets/websites/promod.webp' },
'/assets/websites/trade-republic.png': { redirect: '/assets/websites/trade-republic.webp' },
'/assets/websites/departamento.png': { redirect: '/assets/websites/departamento.webp' },
'/assets/websites/immersive-garden.png': { redirect: '/assets/websites/immersive-garden.webp' },
'/assets/websites/push-security.png': { redirect: '/assets/websites/push-security.webp' },
'/assets/websites/upwork.png': { redirect: '/assets/websites/upwork.webp' },
'/assets/websites/directus.png': { redirect: '/assets/websites/directus.webp' },
'/assets/websites/le-collectionist.png': { redirect: '/assets/websites/le-collectionist.webp' },
'/assets/websites/roland-garros.png': { redirect: '/assets/websites/roland-garros.webp' },
'/assets/websites/vans.png': { redirect: '/assets/websites/vans.webp' },
'/assets/websites/explore-france.png': { redirect: '/assets/websites/explore-france.webp' },
'/assets/websites/louis-vuitton.png': { redirect: '/assets/websites/louis-vuitton.webp' },
'/assets/websites/shaina-mote.png': { redirect: '/assets/websites/shaina-mote.webp' },
// missing redirects
'/docs/4.x/examples/essentials/hello-world': { redirect: '/docs/examples/hello-world', prerender: false },
'/docs/5.x/examples/essentials/hello-world': { redirect: '/docs/examples/hello-world', prerender: false },
'/docs/4.x/api/composables/usehead': { redirect: '/docs/4.x/api/composables/use-head', prerender: false },
'/docs/5.x/api/composables/usehead': { redirect: '/docs/4.x/api/composables/use-head', prerender: false },
'/docs/4.x/examples/composables/use-async-data': { redirect: '/docs/examples/features/data-fetching', prerender: false },
'/docs/5.x/examples/composables/use-async-data': { redirect: '/docs/examples/features/data-fetching', prerender: false },
'/docs/4.x/examples/composables/use-head': { redirect: '/docs/examples/features/meta-tags', prerender: false },
'/docs/5.x/examples/composables/use-head': { redirect: '/docs/examples/features/meta-tags', prerender: false },
'/docs/4.x/getting-started/directory-structure': { redirect: '/docs/4.x/directory-structure', prerender: false },
'/docs/5.x/getting-started/directory-structure': { redirect: '/docs/4.x/directory-structure', prerender: false },
'/docs/guide/going-further/modules': { redirect: '/docs/guide/modules', prerender: false },
'/docs/3.x/guide/going-further/modules': { redirect: '/docs/3.x/guide/modules', prerender: false },
'/docs/4.x/guide/going-further/modules': { redirect: '/docs/4.x/guide/modules', prerender: false },
'/docs/5.x/guide/going-further/modules': { redirect: '/docs/4.x/guide/modules', prerender: false },
'/docs/4.x/guide/concepts/rendering-modes': { redirect: '/docs/4.x/guide/concepts/rendering', prerender: false },
'/docs/5.x/guide/concepts/rendering-modes': { redirect: '/docs/4.x/guide/concepts/rendering', prerender: false },
'/docs/4.x/guide/directory-structure/nuxt.config': { redirect: '/docs/4.x/directory-structure/nuxt-config', prerender: false },
'/docs/5.x/guide/directory-structure/nuxt.config': { redirect: '/docs/4.x/directory-structure/nuxt-config', prerender: false },
'/docs/4.x/getting-started/hooks': { redirect: '/docs/4.x/api/advanced/hooks', prerender: false },
'/docs/5.x/getting-started/hooks': { redirect: '/docs/4.x/api/advanced/hooks', prerender: false },
'/docs/4.x/api/nuxt-hooks': { redirect: '/docs/4.x/api/advanced/hooks', prerender: false },
'/docs/5.x/api/nuxt-hooks': { redirect: '/docs/4.x/api/advanced/hooks', prerender: false },
'/docs/4.x/guide/directory-structure/hooks': { redirect: '/docs/4.x/api/advanced/hooks', prerender: false },
'/docs/5.x/guide/directory-structure/hooks': { redirect: '/docs/4.x/api/advanced/hooks', prerender: false },
'/docs/4.x/robots.txt': { redirect: '/robots.txt', prerender: false },
'/docs/5.x/robots.txt': { redirect: '/robots.txt', prerender: false },
'/deploy/nuxthub': { redirect: '/deploy/vercel', prerender: false },
// Nuxt 2 modules removed from nuxt/modules
'/modules/auth': { redirect: { to: '/modules/auth-utils', statusCode: 301 }, prerender: false },
'/modules/axios': { redirect: { to: '/docs/getting-started/data-fetching', statusCode: 301 }, prerender: false },
'/modules/dotenv': { redirect: { to: '/docs/directory-structure/env', statusCode: 301 }, prerender: false },
'/modules/feed': { redirect: { to: '/modules/module-feed', statusCode: 301 }, prerender: false },
'/modules/firebase': { redirect: { to: '/modules/vuefire', statusCode: 301 }, prerender: false },
'/modules/fontawesome': { redirect: { to: '/modules/nuxt-fontawesome', statusCode: 301 }, prerender: false },
'/modules/google-analytics': { redirect: { to: '/modules/scripts', statusCode: 301 }, prerender: false },
'/modules/google-gtag': { redirect: { to: '/modules/scripts', statusCode: 301 }, prerender: false },
'/modules/gtm': { redirect: { to: '/modules/scripts', statusCode: 301 }, prerender: false },
'/modules/laravel-echo': { redirect: { to: '/modules/nuxt-laravel-echo', statusCode: 301 }, prerender: false },
'/modules/markdownit': { redirect: { to: '/modules/comark', statusCode: 301 }, prerender: false },
'/modules/mdx': { redirect: { to: '/modules/comark', statusCode: 301 }, prerender: false },
'/modules/nuxt2-sentry': { redirect: { to: '/modules/sentry', statusCode: 301 }, prerender: false },
'/modules/proxy': { redirect: { to: '/docs/guide/concepts/rendering#route-rules', statusCode: 301 }, prerender: false },
'/modules/pwa': { redirect: { to: '/modules/vite-pwa-nuxt', statusCode: 301 }, prerender: false },
'/modules/redirect': { redirect: { to: '/docs/guide/concepts/rendering#route-rules', statusCode: 301 }, prerender: false },
'/modules/router': { redirect: { to: '/docs/guide/recipes/custom-routing', statusCode: 301 }, prerender: false },
'/modules/separate-env': { redirect: { to: '/docs/guide/going-further/runtime-config', statusCode: 301 }, prerender: false },
'/modules/svg': { redirect: { to: '/modules/nuxt-svgo', statusCode: 301 }, prerender: false },
'/modules/vuetify': { redirect: { to: '/modules/vuetify-nuxt-module', statusCode: 301 }, prerender: false },
// Deprecated modules removed from nuxt/modules
'/modules/google-fonts': { redirect: { to: '/modules/fonts/migrating-from-google-fonts', statusCode: 301 }, prerender: false }
},
sourcemap: true,
experimental: {
viewTransition: true,
extractAsyncDataHandlers: true,
payloadExtraction: 'client',
defaults: {
nuxtLink: {
externalRelAttribute: 'noopener'
// prefetchOn: { interaction: true }
}
},
// `nuxt-workers` breaks under the Vite environment API.
viteEnvironmentApi: false
},
compatibilityDate: '2026-01-14',
nitro: {
experimental: {
// `pnpm nuxters:sync` (server/tasks/nuxters/sync.ts)
tasks: true
},
// Only scan this directory for `'use workflow'` files.
// @ts-expect-error `@workflow/nitro` does not augment Nuxt's Nitro config type
workflow: {
dirs: ['server/workflows']
},
vercel: {
config: {
// Required for `x-prerender-revalidate` to purge an ISR route.
bypassToken: process.env.VERCEL_BYPASS_TOKEN
}
}
},
hub: {
db: 'sqlite',
kv: true,
cache: true
},
vite: {
// The search worker is an ES module (it imports `comark-content`).
worker: { format: 'es' },
server: {
allowedHosts: process.env.NUXT_DEV_ALLOWED_HOSTS?.split(',')
},
optimizeDeps: {
include: [
'@comark/vue',
'@unhead/schema-org/vue',
'@vue/devtools-core',
'@vue/devtools-kit',
'valibot',
'zod',
'date-fns',
'ai'
],
// Pre-bundling `@sqlite.org/sqlite-wasm` breaks the wasm asset it resolves against its own module URL.
exclude: ['shaders', '@sqlite.org/sqlite-wasm']
}
},
typescript: {
strict: false,
tsConfig: {
include: ['../test/nuxt']
}
},
hooks: {
'components:extend': (components) => {
for (const component of components) {
if (component.global && (component.filePath.includes('@nuxt/ui') || component.filePath.includes('@nuxt+ui'))) {
component.global = false
}
}
}
},
agentDiscovery: {
// The comark instances, bridged through server/utils/agent-source.ts.
source: '~~/server/utils/agent-source',
routes: [
{ path: '/', raw: '/raw/index.md' },
'/docs/**',
'/blog/**',
'/deploy/**',
{ path: '/modules', raw: '/raw/modules.md' },
// Hosted module docs: the module page is the docs `index.md`, so it negotiates too.
...MODULE_DOCS_NAMES.flatMap(name => [moduleDocsPathPrefix(name), `${moduleDocsPathPrefix(name)}/**`]),
{ path: '/changelog', raw: '/raw/changelog.md' },
{ path: '/updates', raw: '/raw/updates.md' }
],
excludePrefixes: {
extend: [
// Nightly docs don't negotiate and stay out of sitemap.md / llms.txt (same as robots Disallow below)
...NEXT_DOC_VERSIONS.map(version => `/docs/${version}/`),
// Archived docs too, and their `/raw` twins 404: agents never get them
...ARCHIVED_DOC_VERSIONS.map(version => `/docs/${version}/`),
// Served by its own handler (server/routes/design.md.get.ts).
'/design.md'
]
},
discovery: {
mcpServerCard: {
endpoint: '/mcp',
name: 'Nuxt',
title: 'Nuxt MCP Server',
description: 'MCP server providing tools, resources and prompts to help AI agents build with Nuxt — search documentation, retrieve guides, fetch module metadata, discover deployment providers, and look up Nuxt contributors (Nuxters).',
documentation: `/docs/${CURRENT_DOCS_VERSION}/guide/ai/mcp`,
repository: 'https://github.com/nuxt/nuxt.com',
license: 'MIT'
},
links: [
{ rel: 'service-desc', href: '/openapi.json', type: 'application/vnd.oai.openapi+json', title: 'OpenAPI specification: machine-readable API surface', anchor: '/' },
{ rel: 'describedby', href: '/design.md', type: 'text/markdown', title: 'Design system' },
{ rel: 'service-doc', href: '/docs', type: 'text/html', anchor: '/docs', title: 'Documentation' }
]
},
llms: {
details: agentHowToCall(SITE_URL)
},
sitemap: {
markdown: {
labels: {
docs: 'Documentation',
deploy: 'Deploy providers'
}
}
}
},
auth: {
// Pages are cached (ISR on Vercel): a session fetched while rendering would be cached with the
// page for every visitor, and the browser would never fetch its own. Always fetch it client-side.
loadStrategy: 'client-only'
},
eslint: {
config: {
stylistic: {
commaDangle: 'never'
}
}
},
evlog: {
env: { service: 'nuxt-com' },
pretty: process.env.CI ? false : undefined,
sampling: {
rates: { info: 30 },
keep: [
{ path: '/api/chats/*' },
{ duration: 2000 }
]
}
},
hints: {
features: {
hydration: true,
lazyLoad: false,
webVitals: true,
thirdPartyScripts: {
options: {
ignoredDomains: ['va.vercel-scripts.com']
}
},
htmlValidate: true
}
},
icon: {
customCollections: [{
prefix: 'custom',
dir: resolve('./app/assets/icons')
}],
clientBundle: {
// Scan app source + all local content for icons. The `**/.*.{yml,yaml}`
// pattern is needed for local `.navigation.yml` dotfiles (e.g. blog,
// enterprise), which `*.yml` skips under `dot:false`.
scan: {
globInclude: ['**/*.{vue,jsx,tsx,md,mdc,mdx,yml,yaml,ts}', '**/.*.{yml,yaml}']
},
includeCustomCollections: true,
// Remote docs nav icons (under `.data/`, unreachable by `scan`) — bundle them
// so they don't pop in on client-side navigation. Regenerate when docs change.
icons: [
'logos:bun', 'lucide:alert-triangle', 'lucide:arrow-left-right', 'lucide:bell-dot',
'lucide:bug-off', 'lucide:cable', 'lucide:cog', 'lucide:component', 'lucide:container',
'lucide:cooking-pot', 'lucide:cpu', 'lucide:eye', 'lucide:flag', 'lucide:folder-tree',
'lucide:map', 'lucide:monitor-cog', 'lucide:panels-top-left', 'lucide:play', 'lucide:route',
'lucide:scan-search', 'lucide:ship', 'lucide:square-check', 'lucide:square-terminal',
'lucide:test-tube', 'lucide:toggle-right',
'simple-icons:codesandbox', 'simple-icons:git', 'simple-icons:google', 'simple-icons:googlechrome',
'simple-icons:mdnwebdocs', 'simple-icons:vite', 'simple-icons:w3c', 'simple-icons:webpack',
'vscode-icons:default-folder', 'vscode-icons:file-type-dotenv', 'vscode-icons:file-type-git', 'vscode-icons:file-type-light-config',
'vscode-icons:file-type-css', 'vscode-icons:file-type-html', 'vscode-icons:file-type-js', 'vscode-icons:file-type-json',
'vscode-icons:file-type-markdown', 'vscode-icons:file-type-npm', 'vscode-icons:file-type-yarn', 'vscode-icons:file-type-pnpm',
'vscode-icons:file-type-bun', 'vscode-icons:file-type-deno', 'vscode-icons:file-type-sass', 'vscode-icons:file-type-scss',
'vscode-icons:file-type-config', 'vscode-icons:file-type-ejs', 'vscode-icons:file-type-nuxt', 'vscode-icons:file-type-tsconfig',
'vscode-icons:file-type-typescript', 'vscode-icons:file-type-vue', 'vscode-icons:default-file',
'vscode-icons:folder-type-app', 'vscode-icons:folder-type-asset', 'vscode-icons:folder-type-component', 'vscode-icons:folder-type-db',
'vscode-icons:folder-type-dist', 'vscode-icons:folder-type-log',
'vscode-icons:folder-type-middleware', 'vscode-icons:folder-type-node', 'vscode-icons:folder-type-nuxt', 'vscode-icons:folder-type-package',
'vscode-icons:folder-type-plugin', 'vscode-icons:folder-type-public', 'vscode-icons:folder-type-server', 'vscode-icons:folder-type-shared',
'vscode-icons:folder-type-src', 'vscode-icons:folder-type-temp', 'vscode-icons:folder-type-tools', 'vscode-icons:folder-type-view'
]
}
},
image: {
format: ['webp', 'jpeg', 'jpg', 'png', 'svg'],
provider: 'ipx',
// Opt-out escape hatch for images IPX must not touch, used by `DocsProseImg`.
providers: {
none: { provider: 'none' }
}
},
llms: {
prerender: false,
domain: SITE_URL,
title: 'Nuxt Docs',
description: 'Nuxt is an open source framework that makes web development intuitive and powerful. Create performant and production-grade full-stack web apps and websites with confidence.',
full: {
title: 'Nuxt Docs',
description: 'The complete Nuxt documentation and blog posts written in Markdown (MDC syntax).'
},
// `navigation` selectors are resolved by nuxt-agent-discovery's comark
// adapter against the merged instance navigation, and every same-origin
// page link is rewritten to its raw markdown twin. The versions the index
// leaves out reach /llms-full.txt through `server/plugins/llms.ts`.
sections: [
{
title: 'When to use this',
description: agentWhenToUse().join('\n\n'),
links: [{ title: 'Nuxt', href: SITE_URL }]
},
{
title: `Nuxt v${CURRENT_DOCS_VERSION.replace('.x', '')} Documentation`,
description: 'The current stable release. Other versions live under /docs/<version> and are listed in full in /llms-full.txt.',
navigation: `/docs/${CURRENT_DOCS_VERSION}`
},
{
title: 'Examples',
description: 'Runnable example projects, with their source',
navigation: '/docs/examples'
},
{
title: 'Deployment Guides',
description: 'Deploy a Nuxt application to any provider',
navigation: '/deploy'
},
{
title: 'Blog',
description: 'Release announcements and deep dives',
navigation: '/blog'
},
...MODULE_DOCS_NAMES.map(name => ({
title: `${MODULE_DOCS[name].title} Documentation`,
description: 'Documentation of an official Nuxt module',
navigation: moduleDocsPathPrefix(name)
})),
{
title: 'Optional',
links: [
{ title: 'Modules', description: 'Every published Nuxt module, as markdown', href: 'https://nuxt.com/raw/modules.md' },
{ title: 'Changelog', description: 'Releases of Nuxt and its official modules', href: 'https://nuxt.com/raw/changelog.md' },
{ title: 'Design system', description: 'Brand and design guidelines', href: 'https://nuxt.com/design.md' },
{ title: 'MCP server card', description: 'Tools agents can call directly', href: 'https://nuxt.com/.well-known/mcp/server-card.json' }
]
}
] as Array<LLMsSection & { navigation?: string }>
},
mcp: {
name: 'Nuxt',
route: '/mcp',
browserRedirect: '/docs/guide/ai/mcp',
icons: [
{ src: 'https://nuxt.com/icon.png', mimeType: 'image/png', sizes: ['64x64'] }
],
logging: true
},
ogImage: {
cacheMaxAgeSeconds: 0,
security: {
renderTimeout: 60000
}
},
robots: {
// The nightly docs version, carried over from the static public/robots.txt
// this replaces. The agent Allow groups and Content-Signal come from
// nuxt-agent-discovery through the robots:config hook.
// Country leaderboards: about 2.3k `?period=` × `?country=` pages, each rendered from the database
// once an hour per crawl. Their canonical is `/nuxters`.
disallow: [...NEXT_DOC_VERSIONS.map(version => `/docs/${version}/`), '/pull/', '/nuxters?*country=']
},
schemaOrg: {
identity: {
type: 'Organization',
name: 'Nuxt',
logo: '/icon.png',
sameAs: [
'https://github.com/nuxt',
'https://x.com/nuxt_js',
'https://bsky.app/profile/nuxt.com',
'https://www.linkedin.com/showcase/nuxt-framework/',
'https://m.webtoo.ls/@nuxt'
]
}
},
sitemap: {
// Content pages come from the dynamic source below, resolved at request
// time (SWR cached by the module). App sources are off: the nuxt:prerender
// source lists every prerendered page, which includes the 3.x/5.x docs and
// the unversioned /docs/* meta-refresh stubs. Vue pages without a content
// counterpart are listed explicitly.
excludeAppSources: true,
sources: ['/api/__sitemap__/urls'],
// Nuxter profiles stay out: 26k near-identical stat pages would only dilute the docs.
urls: ['/', '/showcase', '/changelog', '/updates', '/evals', '/nuxters'],
// Belt and braces should an app source come back: keep legacy/nightly docs
// versions and auth-only areas out.
exclude: [
new RegExp(`^/docs/(?!${CURRENT_DOCS_VERSION.replace('.', '\\.')}/|examples/)`),
'/admin',
'/admin/**',
'/dashboard',
'/dashboard/**',
'/login',
'/chat',
'/chat/**',
'/enterprise',
'/pull/**',
// Redirects to /updates
'/blog'
]
}
})