Skip to content

Plugin documentation #2610

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Plugin documentation #2610

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6dcde3c
yalc integration
maccomaccomaccomacco Jul 23, 2025
ad3d3ed
create a plugin documentation
maccomaccomaccomacco Jul 24, 2025
f0ec34e
Sections' definition
maccomaccomaccomacco Jul 24, 2025
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
Prev Previous commit
Sections' definition
  • Loading branch information
@maccomaccomaccomacco
maccomaccomaccomacco committed Jul 24, 2025
commit f0ec34eef718343a2c3a0e8ceaddcd5e36bb42a3
8 changes: 4 additions & 4 deletions docusaurus/docs/cms/plugins-development/create-a-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ In addition to the plugin location, your Strapi project and plugin can be organi

The development workflow and commands you use will vary based on both the plugin type (local vs external) and the repository setup (separate vs monorepo), as detailed in the sections below.

### Creating the plugin
## Creating the plugin

To create your plugin, ensure you are in the parent directory of where you want it to be created and run the following command:

Expand Down Expand Up @@ -57,7 +57,7 @@ The path `my-strapi-plugin` can be replaced with whatever you want to call your

You will be guided through a series of prompts to help you set up your plugin. If you select "yes" to all options, the final structure will be similar to the default [plugin structure](/cms/plugins-development/plugin-structure).

### Developing local plugins
## Developing local plugins

If you run the Plugin SDK command from within an existing Strapi project, the plugin will be created in a `plugins` folder within that project. If a `plugins` folder already exists, the new plugin code will be placed there. This allows you to develop plugins locally within your project structure.

Expand Down Expand Up @@ -110,7 +110,7 @@ npm run watch

Then run `yarn develop` or `npm run develop` in your Strapi project to start the application with your local plugin.

### External plugins development
## Developing external plugins

:::prerequisites
<ExternalLink to="https://www.npmjs.com/package/yalc" text="yalc"/> must be installed globally (with `npm install -g yalc` or `yarn global add yalc`).
Expand Down Expand Up @@ -180,7 +180,7 @@ Now that your plugin is linked to a project, run `yarn develop` or `npm run deve

You are now ready to develop your plugin as needed! If you are making server changes, you will need to restart your server for them to take effect.

### Building the plugin for publishing
## Building the plugin for publishing

When you are ready to publish your plugin, you will need to build it. To do this, run the following command:

Expand Down
Loading