Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fix broken links in Creating a Generic Plugin guide #39230

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(docs): fix broken links in Creating a Generic Plugin guide #39230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/how-to/plugins-and-themes/creating-a-generic-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Creating a Generic Plugin

This section aims to explain the structure of a Gatsby plugin and the files you need to create one.

The idea of a generic plugin is to lay more emphasis on the makeup of a plugin rather than the specific labels ([source](/docs/how-to/plugins-and-themes/creating-a-source-plugin/), [transformer](/docs/how-to/plugins-and-themes/creating-a-transformer-plugin/), [local](/docs/creating-a-local-plugin/)) that are [selected based on functionality](/docs/how-to/plugins-and-themes/naming-a-plugin/). As seen in the [what is a plugin doc](/docs/what-is-a-plugin/), a plugin is a piece of software that acts as an add-on and gives a Gatsby site additional functionality.
The idea of a generic plugin is to lay more emphasis on the makeup of a plugin rather than the specific labels ([source](/docs/how-to/plugins-and-themes/creating-a-source-plugin/), [transformer](/docs/how-to/plugins-and-themes/creating-a-transformer-plugin/), [local](/docs/how-to/plugins-and-themes/creating-a-local-plugin/)) that are [selected based on functionality](/docs/how-to/plugins-and-themes/naming-a-plugin/). As seen in the [what is a plugin doc](/docs/how-to/plugins-and-themes/what-is-a-plugin/), a plugin is a piece of software that acts as an add-on and gives a Gatsby site additional functionality.

Plugins contain a file, usually in the project root, called `package.json` - this file holds various metadata relevant to the project. The `package.json` file is also used to provide information to npm that identifies the project and allows npm to handle the project's dependencies.

Expand All @@ -16,7 +16,7 @@ To initialize a `package.json` for your project, run the following command:
npm init
```

Once you've run the command you'll see a series of options listed in the command-line interface (CLI). Those you select are stored in your `package.json` which contains some of the [files Gatsby looks for in a Plugin](/docs/files-gatsby-looks-for-in-a-plugin)
Once you've run the command you'll see a series of options listed in the command-line interface (CLI). Those you select are stored in your `package.json` which contains some of the [files Gatsby looks for in a Plugin](/docs/how-to/plugins-and-themes/files-gatsby-looks-for-in-a-plugin/)

## What happens in a generic plugin?

Expand Down