Skip to content

Commit 8b55e7b

Browse files
authored
docs: replace HTML entity ' with literal apostrophe (#11321)
1 parent 48e613b commit 8b55e7b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/plugins/build-your-own.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ desc: Starting to build your own plugin? Find everything you need and learn best
66
keywords: plugins, template, config, configuration, extensions, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
77
---
88

9-
Building your own [Payload Plugin](./overview) is easy, and if you're already familiar with Payload then you'll have everything you need to get started. You can either start from scratch or use the [Plugin Template](#plugin-template) to get up and running quickly.
9+
Building your own [Payload Plugin](./overview) is easy, and if you're already familiar with Payload then you'll have everything you need to get started. You can either start from scratch or use the [Plugin Template](#plugin-template) to get up and running quickly.
1010

1111
<Banner type="success">
1212
To use the template, run `npx create-payload-app@latest --template plugin` directly in
@@ -19,7 +19,7 @@ Our plugin template includes everything you need to build a full life-cycle plug
1919
- A local dev environment to develop the plugin
2020
- Test suite with integrated GitHub workflow
2121

22-
By abstracting your code into a plugin, you&apos;ll be able to reuse your feature across multiple projects and make it available for other developers to use.
22+
By abstracting your code into a plugin, you'll be able to reuse your feature across multiple projects and make it available for other developers to use.
2323

2424
## Plugins Recap
2525

@@ -75,15 +75,15 @@ The purpose of the **dev** folder is to provide a sanitized local Payload projec
7575

7676
Do **not** store any of the plugin functionality in this folder - it is purely an environment to _assist_ you with developing the plugin.
7777

78-
If you&apos;re starting from scratch, you can easily setup a dev environment like this:
78+
If you're starting from scratch, you can easily setup a dev environment like this:
7979

8080
```
8181
mkdir dev
8282
cd dev
8383
npx create-payload-app@latest
8484
```
8585

86-
If you&apos;re using the plugin template, the dev folder is built out for you and the `samplePlugin` has already been installed in `dev/payload.config.ts`.
86+
If you're using the plugin template, the dev folder is built out for you and the `samplePlugin` has already been installed in `dev/payload.config.ts`.
8787

8888
```
8989
plugins: [
@@ -96,7 +96,7 @@ If you&apos;re using the plugin template, the dev folder is built out for you an
9696

9797
You can add to the `dev/payload.config.ts` and build out the dev project as needed to test your plugin.
9898

99-
When you&apos;re ready to start development, navigate into this folder with `cd dev`
99+
When you're ready to start development, navigate into this folder with `cd dev`
100100

101101
And then start the project with `pnpm dev` and pull up `http://localhost:3000` in your browser.
102102

@@ -108,7 +108,7 @@ A good test suite is essential to ensure quality and stability in your plugin. P
108108

109109
Jest organizes tests into test suites and cases. We recommend creating tests based on the expected behavior of your plugin from start to finish. Read more about tests in the [Jest documentation.](https://jestjs.io/)
110110

111-
The plugin template provides a stubbed out test suite at `dev/plugin.spec.ts` which is ready to go - just add in your own test conditions and you&apos;re all set!
111+
The plugin template provides a stubbed out test suite at `dev/plugin.spec.ts` which is ready to go - just add in your own test conditions and you're all set!
112112

113113
```
114114
let payload: Payload
@@ -160,7 +160,7 @@ export const seed = async (payload: Payload): Promise<void> => {
160160

161161
## Building a Plugin
162162

163-
Now that we have our environment setup and dev project ready to go - it&apos;s time to build the plugin!
163+
Now that we have our environment setup and dev project ready to go - it's time to build the plugin!
164164

165165

166166
```
@@ -217,7 +217,7 @@ To reiterate, the essence of a [Payload Plugin](./overview) is simply to extend
217217

218218
We are going to use spread syntax to allow us to add data to existing arrays without losing the existing data. It is crucial to spread the existing data correctly, else this can cause adverse behavior and conflicts with Payload Config and other plugins.
219219

220-
Let&apos;s say you want to build a plugin that adds a new collection:
220+
Let's say you want to build a plugin that adds a new collection:
221221

222222
```
223223
config.collections = [
@@ -227,7 +227,7 @@ config.collections = [
227227
]
228228
```
229229

230-
First, you need to spread the `config.collections` to ensure that we don&apos;t lose the existing collections. Then you can add any additional collections, just as you would in a regular Payload Config.
230+
First, you need to spread the `config.collections` to ensure that we don't lose the existing collections. Then you can add any additional collections, just as you would in a regular Payload Config.
231231

232232
This same logic is applied to other array and object like properties such as admin, globals and hooks:
233233

@@ -284,7 +284,7 @@ For a better user experience, provide a way to disable the plugin without uninst
284284

285285
### Include tests in your GitHub CI workflow
286286

287-
If you&apos;ve configured tests for your package, integrate them into your workflow to run the tests each time you commit to the plugin repository. Learn more about [how to configure tests into your GitHub CI workflow.](https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs)
287+
If you've configured tests for your package, integrate them into your workflow to run the tests each time you commit to the plugin repository. Learn more about [how to configure tests into your GitHub CI workflow.](https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs)
288288

289289
### Publish your finished plugin to npm
290290

0 commit comments

Comments
 (0)