Skip to content

Commit 6736a6d

Browse files
authored
docs(readme): add file extension, fix code block, fix link, fix code (#28905)
1 parent ac8d00c commit 6736a6d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

packages/gatsby-plugin-utils/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
npm install gatsby-plugin-utils
77
```
88

9-
### validateOptionsSchema
9+
### `validateOptionsSchema`
1010

11-
The `validateOptionsSchema` function verifies that the proper data types of options were passed into a plugin from the `gatsby-config` file. It is called internally by Gatsby to validate each plugin's options when a site is started.
11+
The `validateOptionsSchema` function verifies that the proper data types of options were passed into a plugin from the `gatsby-config.js` file. It is called internally by Gatsby to validate each plugin's options when a site is started.
1212

1313
#### Example
1414

@@ -18,9 +18,9 @@ import { validateOptionsSchema } from "gatsby-plugin-utils"
1818
await validateOptionsSchema(pluginName, pluginSchema, pluginOptions)
1919
```
2020

21-
### testPluginOptionsSchema
21+
### `testPluginOptionsSchema`
2222

23-
Utility to validate and test plugin options schemas. An example of a plugin options schema implementation can be found in the [gatsby-node.js file of gatsby-plugin-google-analytics](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-utils).
23+
Utility to validate and test plugin options schemas. An example of a plugin options schema implementation can be found in the [`gatsby-node.js` file of `gatsby-plugin-google-analytics`](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-plugin-google-analytics/src/gatsby-node.js).
2424

2525
#### Example
2626

@@ -31,7 +31,7 @@ import { testPluginOptionsSchema } from "gatsby-plugin-utils"
3131
it(`should partially validate one value of a schema`, async () => {
3232
const pluginSchema = ({ Joi }) =>
3333
Joi.object({
34-
someOtherValue: Joi.string()
34+
someOtherValue: Joi.string(),
3535
toVerify: Joi.boolean(),
3636
})
3737

0 commit comments

Comments
 (0)