Skip to content

Commit

Permalink
docs(gatsby): html.js docs for themes (#19211)
Browse files Browse the repository at this point in the history
* docs(gatsby): html.js docs for themes

#19181

* docs(html): html.js custom placement

* docs(htm): Update docs/docs/custom-html.md

Co-Authored-By: Marcy Sutton <[email protected]>
  • Loading branch information
2 people authored and GatsbyJS Bot committed Nov 12, 2019
1 parent 5479c2b commit 2b48c10
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/docs/custom-html.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ And then make modifications as needed.

If you need to insert custom html into the `<head>` or `<footer>` of each page on your site, you can use `html.js`.

> Customizing `html.js` is a workaround solution for when the use of the appropriate APIs is not available in `gatsby-ssr.js`. Consider using [`onRenderBody`](/docs/ssr-apis/#onRenderBody) or [`onPreRenderHTML`](/docs/ssr-apis/#onPreRenderHTML) instead of the method above.
> As a further consideration, customizing `html.js` is not supported within a Gatsby Theme. Use the API methods mentioned instead.
## Required props

Note: the various props that are rendered into pages _are_ required e.g.
Expand Down

0 comments on commit 2b48c10

Please sign in to comment.