Skip to content

Commit

Permalink
[Docs] Remove html <b> from summaries (#51008)
Browse files Browse the repository at this point in the history
This PR removes manual HTML `<b>` tags in `<details><summary>...` titles. They are unnecessary because we add bold styling in CSS.

Also did a tiny fix to some other unnecessary inline HTML.
  • Loading branch information
delbaoliveira authored Jun 9, 2023
1 parent 9fad474 commit ccc64d9
Show file tree
Hide file tree
Showing 34 changed files with 50 additions and 64 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Style your Next.js Application with CSS Modules.

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [Basic CSS Example](https://github.com/vercel/next.js/tree/canary/examples/basic-css)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Style your Next.js Application using Tailwind CSS.

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [With Tailwind CSS](https://github.com/vercel/next.js/tree/canary/examples/with-tailwindcss)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ export default function RootLayout({ children }) {

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Styled JSX](https://github.com/vercel/next.js/tree/canary/examples/with-styled-jsx)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ related:

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Image Component](https://github.com/vercel/next.js/tree/canary/examples/image-component)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn to add and access environment variables in your Next.js appli

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Environment Variables](https://github.com/vercel/next.js/tree/canary/examples/environment-variables)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Configure module path aliases that allow you to remap certain impor

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Absolute Imports and Aliases](https://github.com/vercel/next.js/tree/canary/examples/with-absolute-imports)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Next.js recommended adding a [property to Page components](/docs/pages/building-

<details>
<summary>
<b>See before and after example</b>
See before and after example
</summary>

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

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Image Component](https://github.com/vercel/next.js/tree/canary/examples/image-component)
Expand Down
2 changes: 1 addition & 1 deletion docs/02-app/02-api-reference/01-components/link.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Enable fast client-side navigation with the built-in `next/link` co

<details>
<summary>
<b>Examples</b>
Examples
</summary>
- [Hello
World](https://github.com/vercel/next.js/tree/canary/examples/hello-world)
Expand Down
8 changes: 2 additions & 6 deletions docs/02-app/02-api-reference/05-next-config-js/env.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,14 @@ description: Learn to add and access environment variables in your Next.js appli
<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [With env](https://github.com/vercel/next.js/tree/canary/examples/with-env-from-next-config-js)

</details>

> <b>Note</b>: environment variables specified in this way will <b>always</b> be
> included in the JavaScript bundle, prefixing the environment variable name
> with `NEXT_PUBLIC_` only has an effect when specifying them [through the
> environment or .env
> files](/docs/pages/building-your-application/configuring/environment-variables).
> **Note**: environment variables specified in this way will **always** be included in the JavaScript bundle, prefixing the environment variable name with `NEXT_PUBLIC_` only has an effect when specifying them [through the environment or .env files](/docs/pages/building-your-application/configuring/environment-variables).
To add environment variables to the JavaScript bundle, open `next.config.js` and add the `env` config:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Customize the pages that will be exported as HTML files when using
<details>
<summary>
<b>Examples</b>
Examples
</summary>
- [Static Export](https://github.com/vercel/next.js/tree/canary/examples/with-static-export)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ module.exports = {

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Incremental adoption of Next.js](https://github.com/vercel/next.js/tree/canary/examples/custom-routes-proxying)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Now, instead of using interpolation to create the path, we use a URL object in `

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Dynamic Routing](https://github.com/vercel/next.js/tree/canary/examples/dynamic-routing)
Expand All @@ -114,7 +114,7 @@ In general we recommend using [`useRouter`](/docs/pages/api-reference/functions/

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Using Router](https://github.com/vercel/next.js/tree/canary/examples/using-router)
Expand Down Expand Up @@ -143,7 +143,7 @@ export default function ReadMore() {

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Shallow Routing](https://github.com/vercel/next.js/tree/canary/examples/with-shallow-routing)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Next.js supports API Routes, which allow you to build your API with

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Basic API Routes](https://github.com/vercel/next.js/tree/canary/examples/api-routes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Next.js has built-in support for internationalized routing and lang

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [i18n routing](https://github.com/vercel/next.js/tree/canary/examples/i18n-routing)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Now that we've discussed authentication patterns, let's look at specific provide

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [with-iron-session](https://github.com/vercel/next.js/tree/canary/examples/with-iron-session)
Expand All @@ -129,7 +129,7 @@ To see examples with other authentication providers, check out the [examples fol

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [Auth0](https://github.com/vercel/next.js/tree/canary/examples/auth0)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Use Static Site Generation (SSG) to pre-render pages at build time.

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [WordPress Example](https://github.com/vercel/next.js/tree/canary/examples/cms-wordpress)([Demo](https://next-blog-wordpress.vercel.app))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,12 @@ description: Learn how to create or update static pages at runtime with Incremen
---

<details>
<summary>
<b>Examples</b>
</summary>
<ul>
<li>
<a href="https://nextjs.org/commerce">Next.js Commerce</a>
</li>
<li>
<a href="https://reactions-demo.vercel.app/">GitHub Reactions Demo</a>
</li>
<li>
<a href="https://static-tweet.vercel.app/">Static Tweet Demo</a>
</li>
</ul>
<summary>Examples</summary>

- [Next.js Commerce](https://nextjs.org/commerce)
- [GitHub Reactions Demo](https://reactions-demo.vercel.app/)
- [Static Tweet Demo](https://static-tweet.vercel.app/)

</details>

Next.js allows you to create or update static pages _after_ you’ve built your site. Incremental Static Regeneration (ISR) enables you to use static-generation on a per-page basis, **without needing to rebuild the entire site**. With ISR, you can retain the benefits of static while scaling to millions of pages.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Learn how to create or update static pages at runtime with Increme

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Next.js Commerce](https://nextjs.org/commerce)
Expand All @@ -15,7 +15,7 @@ description: 'Learn how to create or update static pages at runtime with Increme
</details>

<details>
<summary><b>Version History</b></summary>
<summary>Version History</summary>

| Version | Changes |
| --------- | --------------------------------------------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to set up Next.js with three commonly used testing tools

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [Next.js with Cypress](https://github.com/vercel/next.js/tree/canary/examples/with-cypress)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ description: With minimal config, and without leaving React, you can start addin
---

<details>
<summary>
<b>Examples</b>
</summary>
- [AMP](https://github.com/vercel/next.js/tree/canary/examples/amp)
<summary>Examples</summary>-
[AMP](https://github.com/vercel/next.js/tree/canary/examples/amp)
</details>

With Next.js you can turn any React page into an AMP page, with minimal config, and without leaving React.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Extend the babel preset added by Next.js with your own configs.

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Customizing babel configuration](https://github.com/vercel/next.js/tree/canary/examples/with-custom-babel-config)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Extend the PostCSS config and plugins added by Next.js with your ow

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [Tailwind CSS Example](https://github.com/vercel/next.js/tree/canary/examples/with-tailwindcss)
Expand Down Expand Up @@ -40,7 +40,7 @@ in your entire project by configuring autoprefixer with the configuration shown
See ["Customizing Plugins"](#customizing-plugins) below for more information.

<details>
<summary><strong>Click to view the configuration to enable CSS Grid Layout</strong></summary>
<summary>Click to view the configuration to enable CSS Grid Layout</summary>

```json
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Start a Next.js app programmatically using a custom server.

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Custom Server](https://github.com/vercel/next.js/tree/canary/examples/custom-server)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Next.js has the preview mode for statically generated pages. You ca
<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [WordPress Example](https://github.com/vercel/next.js/tree/canary/examples/cms-wordpress) ([Demo](https://next-blog-wordpress.vercel.app))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Before taking your Next.js application to production, here are some recommendati

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [ssr-caching](https://github.com/vercel/next.js/tree/canary/examples/ssr-caching)
Expand Down Expand Up @@ -81,7 +81,7 @@ By default, `Cache-Control` headers will be set differently depending on how you

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [with-dynamic-import](https://github.com/vercel/next.js/tree/canary/examples/with-dynamic-import)
Expand All @@ -102,7 +102,7 @@ Each file inside your `pages/` directory will automatically be code split into i

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [Pino and Logflare Example](https://github.com/Logflare/next-pino-logflare-logging-example)
Expand All @@ -120,7 +120,7 @@ If you want a structured logging package, we recommend [Pino](https://www.npmjs.

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [with-sentry](https://github.com/vercel/next.js/tree/canary/examples/with-sentry)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to use multi zones to deploy multiple Next.js apps as a s

<details open>
<summary>
<b>Examples</b>
Examples
</summary>

- [With Zones](https://github.com/vercel/next.js/tree/canary/examples/with-zones)
Expand Down
2 changes: 1 addition & 1 deletion docs/03-pages/02-api-reference/01-components/head.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Add custom elements to the `head` of your page with the built-in He

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Head Elements](https://github.com/vercel/next.js/tree/canary/examples/head-elements)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Backwards compatible Image Optimization with the Legacy Image compo

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Legacy Image Component](https://github.com/vercel/next.js/tree/canary/examples/image-legacy-component)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ export default Post

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [Static generation of a large number of pages](https://static-tweet.vercel.app)
Expand Down
2 changes: 1 addition & 1 deletion docs/03-pages/02-api-reference/02-functions/use-amp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Enable AMP in a page, and control the way Next.js adds AMP to the p

<details>
<summary>
<b>Examples</b>
Examples
</summary>

- [AMP](https://github.com/vercel/next.js/tree/canary/examples/amp)
Expand Down
Loading

0 comments on commit ccc64d9

Please sign in to comment.