Skip to content

Commit 941189d

Browse files
franky47franky47
authored
doc: Update to Fumadocs 14 / Next 15 (#749)
* doc: Remove Excalidraw font (saves 62kB) * doc: Reduce amount of prefetching * doc: Restore simplified flattened Virgil font * chore: Update dependencies * chore: Fix linter * chore: Fix docs build * chore: Back to React 19 RC * chore: Enable turbopack for dev * style: Rounded main navbar * chore: Fix stats page (async search params) * chore: Remove unused test pages * doc: Prefer awaiting the parsed promise to showcase overload * chore: Fix more async access to request elements * style: Fix hero layout on large screens * doc: Typo
1 parent 6ee72ee commit 941189d

39 files changed

+2186
-2603
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -671,8 +671,8 @@ import { coordinatesCache } from './searchParams'
671671
import { Server } from './server'
672672
import { Client } from './client'
673673

674-
export default function Page({ searchParams }) {
675-
coordinatesCache.parse(searchParams)
674+
export default async function Page({ searchParams }) {
675+
await coordinatesCache.parse(searchParams)
676676
return (
677677
<>
678678
<Server />

‎errors/NUQS-500.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ Run the `parse` method and feed it the page's `searchParams`:
2525
import {
2626
createSearchParamsCache,
2727
parseAsInteger,
28-
parseAsString
28+
parseAsString,
29+
type SearchParams
2930
} from 'nuqs/server'
3031

3132
const cache = createSearchParamsCache({
@@ -36,10 +37,10 @@ const cache = createSearchParamsCache({
3637
export default function Page({
3738
searchParams
3839
}: {
39-
searchParams: Record<string, string | string[] | undefined>
40+
searchParams: Promise<SearchParams>
4041
}) {
4142
// ⚠️ Don't forget to call `parse` here:
42-
const { q: query } = cache.parse(searchParams)
43+
const { q: query } = await cache.parse(searchParams)
4344
return (
4445
<div>
4546
<h1>Search Results for {query}</h1>

‎package.json

+7-4
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,15 @@
2626
"commitlint": "^19.5.0",
2727
"husky": "^9.1.6",
2828
"prettier": "3.3.3",
29-
"semantic-release": "^24.1.2",
30-
"sherif": "^1.0.0",
31-
"turbo": "^2.1.3",
29+
"semantic-release": "^24.2.0",
30+
"sherif": "^1.0.1",
31+
"turbo": "^2.2.3",
3232
"typescript": "^5.6.3"
3333
},
34-
"packageManager": "pnpm@9.12.1+sha256.91452fdfa46234ae447d46d5c4fc4e7e0a7058f90495c4b6f77f8beebbb154e3",
34+
"packageManager": "pnpm@9.13.0+sha512.beb9e2a803db336c10c9af682b58ad7181ca0fbd0d4119f2b33d5f2582e96d6c0d93c85b23869295b765170fbdaa92890c0da6ada457415039769edf3c959efe",
35+
"resolutions": {
36+
"@headlessui/react": "2.2.0"
37+
},
3538
"prettier": {
3639
"arrowParens": "avoid",
3740
"semi": false,

‎packages/docs/content/docs/server-side.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type PageProps = {
4545
export default async function Page({ searchParams }: PageProps) {
4646
// ⚠️ Don't forget to call `parse` here.
4747
// You can access type-safe values from the returned object:
48-
const { q: query } = searchParamsCache.parse(await searchParams)
48+
const { q: query } = await searchParamsCache.parse(searchParams)
4949
return (
5050
<div>
5151
<h1>Search Results for {query}</h1>
@@ -87,7 +87,7 @@ import { Server } from './server'
8787
import { Client } from './client'
8888

8989
export default async function Page({ searchParams }) {
90-
coordinatesCache.parse(await searchParams)
90+
await coordinatesCache.parse(searchParams)
9191
return (
9292
<>
9393
<Server />

‎packages/docs/content/docs/troubleshooting.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This limitation doesn't apply to the app router.
1818

1919
### Different parsers on the same key
2020

21-
Hooks are synced together on a per-key bassis, so if you use different parsers
21+
Hooks are synced together on a per-key basis, so if you use different parsers
2222
on the same key, the last state update will be propagated to all other hooks
2323
using that key. It can lead to unexpected states like this:
2424

‎packages/docs/next.config.mjs

+7-10
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@ const withFumadocsMDX = createMDX()
77

88
/** @type {import('next').NextConfig} */
99
const config = {
10-
experimental: {
11-
instrumentationHook: true,
12-
outputFileTracingIncludes: {
13-
'/playground/pagination': [
14-
'./src/app/playground/(demos)/pagination/searchParams.ts',
15-
'./src/app/playground/(demos)/pagination/page.tsx',
16-
'./src/app/playground/(demos)/pagination/pagination-controls.server.tsx',
17-
'./src/app/playground/(demos)/pagination/pagination-controls.client.tsx'
18-
]
19-
}
10+
outputFileTracingIncludes: {
11+
'/playground/pagination': [
12+
'./src/app/playground/(demos)/pagination/searchParams.ts',
13+
'./src/app/playground/(demos)/pagination/page.tsx',
14+
'./src/app/playground/(demos)/pagination/pagination-controls.server.tsx',
15+
'./src/app/playground/(demos)/pagination/pagination-controls.client.tsx'
16+
]
2017
},
2118
reactStrictMode: true,
2219
redirects: async () => {

‎packages/docs/package.json

+18-18
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
"directory": "packages/docs"
1515
},
1616
"scripts": {
17-
"dev": "next dev",
17+
"dev": "next dev --turbo",
1818
"build": "next build",
1919
"start": "next start",
2020
"postinstall": "fumadocs-mdx"
2121
},
2222
"dependencies": {
23-
"@faker-js/faker": "^9.0.3",
24-
"@headlessui/react": "^2.1.9",
23+
"@faker-js/faker": "^9.2.0",
24+
"@headlessui/react": "2.2.0",
2525
"@headlessui/tailwindcss": "^0.2.1",
2626
"@icons-pack/react-simple-icons": "^10.1.0",
2727
"@radix-ui/react-checkbox": "^1.1.2",
@@ -33,43 +33,43 @@
3333
"@radix-ui/react-switch": "^1.1.1",
3434
"@radix-ui/react-toggle": "^1.1.0",
3535
"@radix-ui/react-toggle-group": "^1.1.0",
36-
"@sentry/nextjs": "^8.33.1",
36+
"@sentry/nextjs": "^8.38.0",
3737
"@tailwindcss/container-queries": "^0.1.1",
38-
"@tremor/react": "^3.18.3",
38+
"@tremor/react": "^3.18.4",
3939
"cheerio": "1.0.0-rc.12",
4040
"class-variance-authority": "^0.7.0",
4141
"clsx": "^2.1.1",
4242
"dayjs": "^1.11.13",
43-
"fumadocs-core": "^13.4.10",
44-
"fumadocs-mdx": "^10.0.2",
45-
"fumadocs-ui": "^13.4.10",
46-
"lucide-react": "^0.451.0",
47-
"next": "14.2.15",
43+
"fumadocs-core": "^14.4.0",
44+
"fumadocs-mdx": "^11.1.1",
45+
"fumadocs-ui": "^14.4.0",
46+
"lucide-react": "^0.456.0",
47+
"next": "15.0.3",
4848
"nuqs": "workspace:*",
4949
"pretty-bytes": "^6.1.1",
5050
"react": "catalog:react19rc",
5151
"react-dom": "catalog:react19rc",
52-
"recharts": "^2.12.7",
52+
"recharts": "^2.13.3",
5353
"remark-smartypants": "^3.0.2",
5454
"res": "workspace:*",
5555
"semver": "^7.6.3",
5656
"server-only": "^0.0.1",
57-
"tailwind-merge": "^2.5.3",
58-
"tailwindcss": "^3.4.13",
57+
"tailwind-merge": "^2.5.4",
58+
"tailwindcss": "^3.4.14",
5959
"tailwindcss-animate": "^1.0.7",
6060
"zod": "^3.23.8"
6161
},
6262
"devDependencies": {
63-
"@shikijs/transformers": "^1.22.0",
63+
"@shikijs/transformers": "^1.22.2",
6464
"@types/mdx": "^2.0.13",
65-
"@types/react": "^18.3.11",
66-
"@types/react-dom": "^18.3.0",
65+
"@types/react": "^18.3.12",
66+
"@types/react-dom": "^18.3.1",
6767
"@types/semver": "^7.5.8",
6868
"autoprefixer": "^10.4.20",
6969
"hast-util-to-jsx-runtime": "^2.3.2",
70-
"postcss": "^8.4.47",
70+
"postcss": "^8.4.49",
7171
"prettier-plugin-tailwindcss": "^0.6.8",
72-
"shiki": "^1.22.0",
72+
"shiki": "^1.22.2",
7373
"typescript": "^5.6.3"
7474
},
7575
"postcss": {

‎packages/docs/src/app/(pages)/_landing/demo.tsx

+29-37
Original file line numberDiff line numberDiff line change
@@ -33,46 +33,38 @@ export async function LandingDemo() {
3333

3434
function LookAtTheURL() {
3535
return (
36-
<svg
37-
version="1.1"
38-
xmlns="http://www.w3.org/2000/svg"
39-
viewBox="0 0 270.7398884431316 71.55654506560859"
40-
className="pointer-events-none absolute -top-20 left-0 right-0 mx-auto w-64 select-none opacity-0 transition-opacity peer-data-[interacted=true]:opacity-100 sm:left-16 sm:right-auto sm:mx-0 xl:-left-72 xl:-top-6 xl:mx-0"
41-
// width="541.4797768862632"
42-
// height="143.11309013121718"
43-
>
44-
<text
45-
x="84.43988539137376"
46-
y="33.319640699669435"
47-
fontFamily="Virgil, Segoe UI Emoji"
48-
fontSize="20px"
49-
fill="currentColor"
50-
direction="ltr"
51-
dominantBaseline="text-before-edge"
36+
<>
37+
<svg
38+
xmlns="http://www.w3.org/2000/svg"
39+
viewBox="0 0 315 72"
40+
className="pointer-events-none absolute -top-20 left-0 right-0 mx-auto w-64 select-none opacity-0 transition-opacity peer-data-[interacted=true]:opacity-100 sm:left-16 sm:right-auto sm:mx-0 xl:-left-72 xl:-top-6 xl:mx-0"
5241
>
53-
Look at the URL!
54-
</text>
55-
<g strokeLinecap="round" className="opacity-50">
56-
<path
57-
d="M72 50c-3 2-11 10-18 11s-17 1-23-3c-6-3-10-8-14-16-3-8-6-27-7-32m62 40c-3 2-11 10-18 11s-17 1-23-3c-6-3-10-8-14-16-3-8-6-27-7-32"
58-
stroke="currentColor"
59-
strokeWidth="1"
60-
fill="none"
61-
strokeDasharray="3 4"
62-
/>
63-
<path
64-
d="m18 24-8-14m8 14-8-14"
42+
<g
43+
// Arrow
44+
strokeLinecap="round"
45+
className="opacity-50"
6546
stroke="currentColor"
6647
strokeWidth="1"
6748
fill="none"
68-
/>
69-
<path
70-
d="m7 26 3-16M7 26l3-16"
71-
stroke="currentColor"
72-
strokeWidth="1"
73-
fill="none"
74-
/>
75-
</g>
76-
</svg>
49+
>
50+
<path
51+
d="M72 50c-3 2-11 10-18 11s-17 1-23-3c-6-3-10-8-14-16-3-8-6-27-7-32m62 40c-3 2-11 10-18 11s-17 1-23-3c-6-3-10-8-14-16-3-8-6-27-7-32"
52+
strokeDasharray="3 4"
53+
/>
54+
<path d="m18 24-8-14m8 14-8-14" />
55+
<path d="m7 26 3-16M7 26l3-16" />
56+
</g>
57+
<g
58+
// Text
59+
fill="currentColor"
60+
>
61+
<path d="M92.0004 52.8517C88.734 52.7597 82.1643 54.5445 81.7051 49.7045C82.2244 45.0641 85.4917 40.8334 85.6709 36.2531C88.7787 33.3884 87.7595 39.0805 86.774 40.928C86.3567 43.8113 83.3661 47.1269 84.7779 49.8577C88.4384 52.2298 94.423 47.6524 96.833 52.0638C96.4027 54.4093 93.547 52.441 92.0004 52.8517ZM117.319 42.4251C121.456 41.3467 128.248 46.2608 124.393 50.3041C121.381 53.8324 112.228 53.7254 112.285 48.5752C112.701 44.9113 113.309 44.1938 117.319 42.4251ZM114.78 49.2536C116.64 52.6099 123.789 50.5272 123.106 46.7586C120.459 43.0037 114.448 44.5458 114.78 49.2536ZM130.242 48.991C128.75 45.9256 129.87 52.7896 127.642 52.8254C125.068 52.6705 126.33 49.5625 127.064 48.3081C127.085 44.1724 126.515 39.6086 127.09 35.7016C130.43 36.2969 128.554 41.9138 129.428 44.1847C133.999 42.5861 138.029 37.796 143.216 38.6956C144.149 40.8298 139.015 40.5746 137.674 42.0836C136.19 43.8113 132.218 44.4222 131.896 46.7323C132.456 49.3266 134.917 50.1748 136.755 50.6193C137.976 53.5907 133.902 53.8457 132.723 51.562C131.662 50.9593 130.985 49.9078 130.242 48.991ZM163.276 48.9647C161.393 52.672 154.431 55.1847 153.112 49.7001C152.747 44.9879 159.247 40.9377 162.934 43.817C165.425 46.0797 166.257 50.3012 169.763 51.7749C168.103 55.5856 164.612 50.4709 163.276 48.9647ZM155.292 48.9647C157.156 53.2225 163.043 47.4569 161.7 44.7888C158.889 44.7212 155.907 46.0123 155.292 48.9647ZM202.362 51.7224C201.897 47.9314 203.726 45.2453 198.948 47.0737C196.851 49.0364 195.457 44.9335 198.496 44.2086C203.112 44.0097 202.146 43.8417 202.021 39.2734C204.898 37.5277 203.55 42.607 205.015 43.0817C207.081 43.0775 211.41 41.1662 211.844 43.9221C209.755 45.2156 206.69 44.7017 204.516 45.9181C203.452 48.3021 207.19 52.0507 203.702 53.0356C202.901 52.9748 202.697 52.2594 202.362 51.7224Z" />
62+
<path d="M219.387 46.4958C216.243 47.5337 215.763 51.6177 213.136 52.9829C210.232 51.3014 213.086 47.2739 211.981 44.526C212.728 42.4511 210.406 37.8319 212.664 37.0409C215.072 39.9266 213.619 44.6874 214.476 47.8352C216.245 45.9692 219.923 41.2182 222.04 45.3927C222.971 47.7964 224.237 50.837 223.616 53.298C220.569 53.1977 221.485 47.6717 219.387 46.4958ZM224.801 49.7525C225.362 44.9719 231.592 39.1128 235.884 43.528C238.895 48.1222 231.048 51.5073 228.084 47.9403C224.979 51.1567 230.798 55.1352 234.098 53.8496C236.583 53.8398 239.758 51.8355 241.925 53.2193C241.666 56.1568 237.044 55.1351 234.939 56.0557C230.704 57.0988 224.571 54.8558 224.801 49.7525ZM228.846 46.522C230.481 47.0176 234.393 47.5295 233.941 44.9462C232.085 43.4403 229.932 44.9215 228.846 46.522ZM252.201 44.6134C252.839 42.613 252.13 38.5144 254.854 38.1526C257.128 40.4324 253.211 43.793 254.778 46.6577C255.164 50.6854 260.015 51.0103 261.672 47.6776C263.699 45.0722 266.022 41.6893 264.954 38.3015C267.499 35.7948 267.86 43.4427 266.214 45.075C263.98 49.0668 262.226 52.6309 256.97 52.7465C253.412 51.9424 252.051 47.8824 252.201 44.6134ZM268.252 46.6534C269.466 42.3169 266.531 32.8108 271.562 34.1782C275.729 36.0535 281.706 35.8095 284.378 40.3501C284.708 43.8413 280.066 44.8347 277.734 45.3139C279.385 47.767 284.776 49.3113 283.196 52.7728C280.366 51.6928 278.636 48.4618 275.816 46.9948C274.088 46.0576 270.254 42.9116 273.426 41.5057C275.735 42.5861 279.933 43.8114 281.542 41.0592C280.222 38.4011 276.188 37.7704 273.426 37.356C268.585 36.5019 272.258 40.924 270.747 43.6593C269.543 46.7024 272.066 49.3584 271.089 52.1424C267.718 55.093 268.533 48.1864 268.252 46.6534ZM295.491 52.8516C292.225 52.7596 285.655 54.5443 285.196 49.7044C285.716 45.0639 288.983 40.8333 289.162 36.253C292.27 33.3883 291.251 39.0804 290.265 40.9279C289.848 43.8111 286.857 47.1267 288.269 49.8575C291.929 52.2297 297.914 47.6523 300.324 52.0637C299.899 54.4127 297.027 52.4369 295.491 52.8516ZM305.094 30.6326C308.022 31.6789 305.307 35.9247 305.54 39.5097C305.401 43.1228 304.726 44.2941 305.139 47.8173C305.612 49.2803 304.085 50.8044 302.791 48.328C302.864 46.011 303.7 35.6977 305.094 30.6326Z" />
63+
<path d="M304.078 53.2732C304.762 53.2732 305.316 52.7405 305.316 52.0834C305.316 51.4263 304.762 50.8936 304.078 50.8936C303.395 50.8936 302.841 51.4263 302.841 52.0834C302.841 52.7405 303.395 53.2732 304.078 53.2732Z" />
64+
<path d="M174.385 51.97C173.92 48.1789 175.749 45.4927 170.971 47.3212C168.874 49.284 167.479 45.181 170.519 44.4561C175.134 44.2572 174.169 44.0891 174.044 39.5207C176.921 37.775 175.573 42.8544 177.038 43.3291C179.104 43.3249 183.433 41.4136 183.867 44.1695C181.778 45.4631 178.713 44.9492 176.539 46.1656C175.475 48.5497 179.213 52.2983 175.725 53.2832C174.924 53.2225 174.72 52.507 174.385 51.97Z" />
65+
<path d="M102.575 42.4747C106.713 41.3963 113.504 46.3105 109.649 50.354C106.638 53.8824 97.4838 53.7753 97.5413 48.625C97.9569 44.961 98.5655 44.2435 102.575 42.4747ZM100.036 49.3034C101.896 52.6598 109.046 50.5771 108.362 46.8083C105.716 43.0534 99.7041 44.5955 100.036 49.3034Z" />
66+
</g>
67+
</svg>
68+
</>
7769
)
7870
}

‎packages/docs/src/app/(pages)/_landing/footer.tsx

+17-9
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,25 @@ export default function Component() {
3838
<h3 className="text-xl font-semibold">Quick Links</h3>
3939
<ul className="space-y-2">
4040
<li>
41-
<Link href="/docs" className="hover:underline">
41+
<Link href="/docs" className="hover:underline" prefetch={false}>
4242
Documentation
4343
</Link>
4444
</li>
4545
<li>
46-
<Link href="/playground" className="hover:underline">
46+
<Link
47+
href="/playground"
48+
className="hover:underline"
49+
prefetch={false}
50+
>
4751
Playground
4852
</Link>
4953
</li>
5054
<li>
51-
<Link href="/stats" className="hover:underline">
55+
<Link
56+
href="/stats"
57+
className="hover:underline"
58+
prefetch={false}
59+
>
5260
Project Stats
5361
</Link>
5462
</li>
@@ -58,31 +66,31 @@ export default function Component() {
5866
<h3 className="text-xl font-semibold">Social</h3>
5967
<ul className="space-y-1">
6068
<li>
61-
<Link
69+
<a
6270
href="https://github.com/47ng/nuqs"
6371
className="inline-flex items-center gap-1 hover:underline"
6472
>
6573
<SiGithub role="presentation" className="mr-2 size-5" />
6674
<span>GitHub</span>
67-
</Link>
75+
</a>
6876
</li>
6977
<li>
70-
<Link
78+
<a
7179
href="https://www.youtube.com/@47ng-dev"
7280
className="inline-flex items-center gap-1 hover:underline"
7381
>
7482
<SiYoutube role="presentation" className="mr-2 size-5" />
7583
<span>YouTube</span>
76-
</Link>
84+
</a>
7785
</li>
7886
<li>
79-
<Link
87+
<a
8088
href="https://bsky.app/profile/nuqs.47ng.com"
8189
className="inline-flex items-center gap-1 hover:underline"
8290
>
8391
<SiBluesky role="presentation" className="mr-2 size-5" />
8492
<span>Bluesky</span>
85-
</Link>
93+
</a>
8694
</li>
8795
</ul>
8896
</div>

‎packages/docs/src/app/(pages)/_landing/hero.tsx

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { LandingDemo } from './demo'
77

88
export function HeroSection() {
99
return (
10-
<section className="container relative flex flex-col justify-center gap-8 xl:h-[calc(100vh-4rem)] xl:flex-row">
10+
<section className="container relative mb-12 grid grid-cols-1 items-center justify-center gap-8 xl:h-[max(650px,min(800px,calc(75vh)))] xl:grid-cols-2 xl:flex-row">
1111
<aside className="my-16 flex flex-col items-center self-center xl:my-24 xl:-mr-10 xl:ml-10 xl:flex-1 xl:items-start">
1212
<h1 className="text-6xl md:text-8xl">
1313
<NuqsWordmark />
@@ -45,11 +45,11 @@ export function HeroSection() {
4545
</a>
4646
</nav>
4747
</aside>
48-
<aside className="relative my-4 xl:my-8 xl:flex-1">
48+
<aside className="relative my-4 xl:my-auto xl:flex-1 xl:pt-4">
4949
<LandingDemo />
5050
</aside>
5151
<div
52-
className="absolute bottom-2 left-0 right-0 hidden h-12 items-center justify-center xl:flex"
52+
className="absolute -bottom-12 left-0 right-0 hidden h-12 items-center justify-center xl:flex"
5353
aria-hidden
5454
>
5555
<ChevronDown />

‎packages/docs/src/app/(pages)/blog/[slug]/page.tsx

+3-3
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ export default async function Page(props: {
6060
export async function generateMetadata(props: {
6161
params: Promise<{ slug: string }>
6262
}): Promise<Metadata> {
63-
const params = await props.params
64-
const page = blog.getPage([params.slug])
63+
const { slug } = await props.params
64+
const page = blog.getPage([slug])
6565

6666
if (!page) notFound()
6767

@@ -74,7 +74,7 @@ export async function generateMetadata(props: {
7474
}
7575
}
7676

77-
export function generateStaticParams(): { slug: string }[] {
77+
export async function generateStaticParams(): Promise<{ slug: string }[]> {
7878
return blog.getPages().map(page => ({
7979
slug: page.slugs[0]
8080
}))

‎packages/docs/src/app/(pages)/layout.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { getSharedLayoutProps } from '@/src/components/shared-layout'
2-
import { HomeLayout } from 'fumadocs-ui/home-layout'
2+
import { HomeLayout } from 'fumadocs-ui/layouts/home'
33

44
export default function PageLayout({
55
children

0 commit comments

Comments
 (0)