Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

Commit c1214bd

Browse files
selbekkrakannimer
authored andcommitted
docs: use react-helmet-async instead of react-helmet (#85)
This commit updates the documentation to recommend `react-helmet-async` instead of `react-helmet`, as well as a note about why.
1 parent 783d17c commit c1214bd

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

src/docs/documentation/customizing/add-favicon-and-metadata.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ menu: Customizing
77

88
# Add favicon and metadata
99

10-
Adding metadata to your site is done by configuring Gatsby in combination with [`react-helmet`](https://github.com/nfl/react-helmet) [**source @ gatsby**](https://www.gatsbyjs.org/docs/add-page-metadata/).
10+
Adding metadata to your site is done by configuring Gatsby in combination with [`react-helmet-async`](https://github.com/staylor/react-helmet-async) [**source @ gatsby**](https://www.gatsbyjs.org/docs/add-page-metadata/).
11+
12+
> Please note that we're referencing `react-helmet-async`, and not `react-helmet`. This is because of [this issue](https://github.com/nfl/react-helmet/issues/426). `react-helmet-async` is an API-compatible fork, so you shouldn't need to do anything except importing from a different package.
1113
1214

1315
### Shadowing the Wrapper-component
@@ -18,7 +20,7 @@ The metadata is set up in a file called `wrapper.js` which lives in docz theme p
1820
2. Paste the following content and edit it to your liking
1921
```js
2022
import * as React from 'react'
21-
import { Helmet } from 'react-helmet'
23+
import { Helmet } from 'react-helmet-async'
2224

2325
const Wrapper = ({ children }) => <React.Fragment>
2426
<Helmet>

0 commit comments

Comments
 (0)