Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/01-app/01-getting-started/01-installation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to set up a new Next.js project
nav_title: Installation
description: Create a new Next.js application with the `create-next-app` CLI, and set up TypeScript, ESLint, and Module Path Aliases.
title: Installation
description: Learn how to create a new Next.js application with the `create-next-app` CLI, and set up TypeScript, ESLint, and Module Path Aliases.
---

{/* The content of this doc is shared between the app and pages router. You can use the `<PagesOnly>Content</PagesOnly>` component to add content that is specific to the Pages Router. Any shared content should not be wrapped in a component. */}
Expand Down
2 changes: 1 addition & 1 deletion docs/01-app/01-getting-started/02-project-structure.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Project structure and organization
nav_title: Project Structure
description: An overview of the folder and file conventions in Next.js, and how to organize your project.
description: Learn the folder and file conventions in Next.js, and how to organize your project.
---

This page provides an overview of **all** the folder and file conventions in Next.js, and recommendations for organizing your project.
Expand Down
5 changes: 2 additions & 3 deletions docs/01-app/01-getting-started/03-layouts-and-pages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to create layouts and pages
nav_title: Layouts and Pages
description: Create your first pages and layouts, and link between them.
title: Layouts and Pages
description: Learn how to create your first pages and layouts, and link between them with the Link component.
related:
title: API Reference
description: Learn more about the features mentioned in this page by reading the API Reference.
Expand Down
3 changes: 2 additions & 1 deletion docs/01-app/01-getting-started/04-linking-and-navigating.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Linking and Navigating
description: Learn how prefetching, prerendering, and client-side navigation works in Next.js, and how to use the Link Component.
description: Learn how the built-in navigation optimizations work, including prefetching, prerendering, and client-side navigation, and how to optimize navigation for dynamic routes and slow networks.
related:
links:
- app/api-reference/components/link
- app/api-reference/file-conventions/loading
- app/guides/prefetching
---

In Next.js, routes are rendered on the server by default. This often means the client has to wait for a server response before a new route can be shown. Next.js comes built-in [prefetching](#prefetching), [streaming](#streaming), and [client-side transitions](#client-side-transitions) ensuring navigation stays fast and responsive.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to use Server and Client Components
nav_title: Server and Client Components
title: Server and Client Components
description: Learn how you can use React Server and Client Components to render parts of your application on the server or the client.
related:
title: Next Steps
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to use Partial Prerendering
nav_title: Partial Prerendering
description: Learn how to combine the benefits of static and dynamic rendering with Partial Prerendering.
title: Partial Prerendering
description: Learn how to use Partial Prerendering and combine the benefits of static and dynamic rendering.
version: experimental
related:
title: Next Steps
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: How to fetch data and stream
nav_title: Fetching Data
description: Start fetching data and streaming content in your application.
title: Fetching Data and Streaming
description: Learn how to fetch data and stream content that depends on data.
related:
title: API Reference
description: Learn more about the features mentioned in this page by reading the API Reference.
links:
- app/guides/data-security
- app/api-reference/functions/fetch
- app/api-reference/file-conventions/loading
- app/api-reference/config/next-config-js/logging
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to update data
nav_title: Updating Data
description: Learn how to update data in your Next.js application.
title: Updating data
description: Learn how to mutate data using Server Functions.
related:
title: API Reference
description: Learn more about the features mentioned in this page by reading the API Reference.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to handle errors
nav_title: Error Handling
title: Error Handling
description: Learn how to display expected errors and handle uncaught exceptions.
related:
title: API Reference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to cache and revalidate data
nav_title: Caching and Revalidating
title: Caching and Revalidating
description: Learn how to cache and revalidate data in your application.
related:
title: API Reference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to use CSS in your application
nav_title: CSS
title: CSS
description: Learn about the different ways to add CSS to your application, including CSS Modules, Global CSS, Tailwind CSS, and more.
related:
title: Next Steps
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to optimize images
nav_title: Images
title: Image Optimization
description: Learn how to optimize images in Next.js
related:
title: API Reference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to use fonts
nav_title: Fonts
description: Learn how to use fonts in Next.js
title: Font Optimization
description: Learn how to optimize fonts in Next.js
related:
title: API Reference
description: See the API Reference for the full feature set of Next.js Font
Expand Down
3 changes: 1 addition & 2 deletions docs/01-app/01-getting-started/14-metadata-and-og-images.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to add metadata and create OG images
nav_title: Metadata and OG images
title: Metadata and OG images
description: Learn how to add metadata to your pages and create dynamic OG images.
related:
title: API Reference
Expand Down
3 changes: 1 addition & 2 deletions docs/01-app/01-getting-started/15-deploying.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: How to deploy your Next.js application
nav_title: Deploying
title: Deploying
description: Learn how to deploy your Next.js application.
---

Expand Down
5 changes: 2 additions & 3 deletions docs/01-app/01-getting-started/16-upgrading.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to upgrade your Next.js app
nav_title: Upgrading
description: Learn how to upgrade your Next.js application to the latest version.
title: Upgrading
description: Learn how to upgrade your Next.js application to the latest version or canary.
related:
title: Version guides
description: See the version guides for in-depth upgrade instructions.
Expand Down
61 changes: 1 addition & 60 deletions docs/01-app/02-guides/index.mdx
Original file line number Diff line number Diff line change
@@ -1,63 +1,4 @@
---
title: Guides
description: Learn how to implement common UI patterns and use cases using Next.js
description: Learn how to implement common patterns and real-world use cases using Next.js
---

### Data Fetching

- [Using the `fetch` API](/docs/app/getting-started/fetching-data#with-the-fetch-api)
- [Using an ORM or database client](/docs/app/getting-started/fetching-data#with-an-orm-or-database)
- [Reading search params on the server](/docs/app/api-reference/file-conventions/page)
- [Reading search params on the client](/docs/app/api-reference/functions/use-search-params)

### Revalidating Data

- [Using ISR to revalidate data after a certain time](/docs/app/guides/incremental-static-regeneration#time-based-revalidation)
- [Using ISR to revalidate data on-demand](/docs/app/guides/incremental-static-regeneration#on-demand-revalidation-with-revalidatepath)

### Forms

- [Showing a pending state while submitting a form](/docs/app/guides/forms)
- [Server-side form validation](/docs/app/guides/forms)
- [Handling expected errors](/docs/app/getting-started/error-handling#handling-expected-errors)
- [Handling unexpected exceptions](/docs/app/getting-started/error-handling#handling-uncaught-exceptions)
- [Showing optimistic UI updates](/docs/app/guides/forms#optimistic-updates)
- [Programmatic form submission](/docs/app/guides/forms#programmatic-form-submission)

### Server Actions

- [Passing additional values](/docs/app/guides/forms)
- [Revalidating data](/docs/app/getting-started/updating-data#revalidating)
- [Redirecting](/docs/app/guides/redirecting)
- [Setting cookies](/docs/app/api-reference/functions/cookies#setting-a-cookie)
- [Deleting cookies](/docs/app/api-reference/functions/cookies#deleting-cookies)

### Metadata

- [Creating an RSS feed](/docs/app/api-reference/file-conventions/route#non-ui-responses)
- [Creating an Open Graph image](/docs/app/api-reference/file-conventions/metadata/opengraph-image)
- [Creating a sitemap](/docs/app/api-reference/file-conventions/metadata/sitemap)
- [Creating a robots.txt file](/docs/app/api-reference/file-conventions/metadata/robots)
- [Creating a custom 404 page](/docs/app/api-reference/file-conventions/not-found)
- [Creating a custom 500 page](/docs/app/api-reference/file-conventions/error)

### Auth

- [Creating a sign-up form](/docs/app/guides/authentication#sign-up-and-login-functionality)
- [Stateless, cookie-based session management](/docs/app/guides/authentication#stateless-sessions)
- [Stateful, database-backed session management](/docs/app/guides/authentication#database-sessions)
- [Managing authorization](/docs/app/guides/authentication#authorization)

### Testing

- [Vitest](/docs/app/guides/testing/vitest)
- [Jest](/docs/app/guides/testing/jest)
- [Playwright](/docs/app/guides/testing/playwright)
- [Cypress](/docs/app/guides/testing/cypress)

### Deployment

- [Creating a Dockerfile](/docs/app/getting-started/deploying#docker)
- [Creating a static export (SPA)](/docs/app/guides/static-exports)
- [Configuring caching when self-hosting](/docs/app/guides/self-hosting#configuring-caching)
- [Configuring Image Optimization when self-hosting](/docs/app/guides/self-hosting#image-optimization)
2 changes: 1 addition & 1 deletion docs/01-app/05-api-reference/02-components/form.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Form
title: Form Component
description: Learn how to use the `<Form>` component to handle form submissions and search params updates with client-side navigation.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/01-app/05-api-reference/02-components/image.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Image
title: Image Component
description: Optimize Images in your Next.js Application using the built-in `next/image` Component.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/01-app/05-api-reference/02-components/link.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Link
title: Link Component
description: Enable fast client-side navigation with the built-in `next/link` component.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/01-app/05-api-reference/02-components/script.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Script
title: Script Component
description: Optimize third-party scripts in your Next.js application using the built-in `next/script` Component.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Introduction
title: Next.js Docs
description: Welcome to the Next.js Documentation.
related:
title: Next Steps
Expand Down