From 68d06fe015b28d8f81da52ca107a5f4bd72ab37c Mon Sep 17 00:00:00 2001 From: Grace Yun <74513600+jueungrace@users.noreply.github.com> Date: Mon, 19 Dec 2022 14:49:41 -0500 Subject: [PATCH] Update README templates to include snippet on `next/font` (#44088) Updates the README templates for `create-next-app` to include information on the addition of the `next/font` library. ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md) ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md) ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm build && pnpm lint` - [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md) --- packages/create-next-app/templates/app/js/README-template.md | 2 ++ packages/create-next-app/templates/app/ts/README-template.md | 2 ++ .../create-next-app/templates/default/js/README-template.md | 2 ++ .../create-next-app/templates/default/ts/README-template.md | 2 ++ 4 files changed, 8 insertions(+) diff --git a/packages/create-next-app/templates/app/js/README-template.md b/packages/create-next-app/templates/app/js/README-template.md index e0e00771d879691..bef386655364acb 100644 --- a/packages/create-next-app/templates/app/js/README-template.md +++ b/packages/create-next-app/templates/app/js/README-template.md @@ -18,6 +18,8 @@ You can start editing the page by modifying `app/page.jsx`. The page auto-update The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. + ## Learn More To learn more about Next.js, take a look at the following resources: diff --git a/packages/create-next-app/templates/app/ts/README-template.md b/packages/create-next-app/templates/app/ts/README-template.md index 331172e45f6d009..bb30f88bc869e48 100644 --- a/packages/create-next-app/templates/app/ts/README-template.md +++ b/packages/create-next-app/templates/app/ts/README-template.md @@ -18,6 +18,8 @@ You can start editing the page by modifying `app/page.tsx`. The page auto-update The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. + ## Learn More To learn more about Next.js, take a look at the following resources: diff --git a/packages/create-next-app/templates/default/js/README-template.md b/packages/create-next-app/templates/default/js/README-template.md index b12f3e33e7d5bdb..a25d769b27cfa25 100644 --- a/packages/create-next-app/templates/default/js/README-template.md +++ b/packages/create-next-app/templates/default/js/README-template.md @@ -18,6 +18,8 @@ You can start editing the page by modifying `pages/index.js`. The page auto-upda The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. + ## Learn More To learn more about Next.js, take a look at the following resources: diff --git a/packages/create-next-app/templates/default/ts/README-template.md b/packages/create-next-app/templates/default/ts/README-template.md index c87e0421d2214fa..fb9bcc9fb560d46 100644 --- a/packages/create-next-app/templates/default/ts/README-template.md +++ b/packages/create-next-app/templates/default/ts/README-template.md @@ -18,6 +18,8 @@ You can start editing the page by modifying `pages/index.tsx`. The page auto-upd The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. + ## Learn More To learn more about Next.js, take a look at the following resources: