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

Show file tree
Hide file tree
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
Next Next commit
yalc integration
  • Loading branch information
@maccomaccomaccomacco
maccomaccomaccomacco committed Jul 23, 2025
commit 6dcde3cfedbe3cfe96b1f110ef6da9a0c32534a2
9 changes: 9 additions & 0 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 @@ -25,6 +25,11 @@ This guide assumes you want to develop a plugin external to your Strapi project.

:::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`).

**Why yalc?** `yalc` is a local package manager that enables efficient plugin development by allowing you to test your plugin in a real Strapi project without publishing it to npm first. It provides reliable linking between your plugin and Strapi project for immediate testing during development.

:::note
If you're working in a monorepo environment, you don't need `yalc` because the monorepo workspace setup handles the symlinking automatically.
:::

## Getting started with the Plugin SDK
Expand Down Expand Up @@ -59,6 +64,10 @@ npx @strapi/sdk-plugin init my-strapi-plugin

The path `my-strapi-plugin` can be replaced with whatever you want to call your plugin, including the path to where it should be created (e.g., `code/strapi-plugins/my-new-strapi-plugin`).

:::note
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.
:::

You will be ran through a series of prompts to help you setup your plugin. If you selected yes to all options the final structure will be similar to the default [plugin structure](/cms/plugins-development/plugin-structure).

### Linking the plugin to your project
Expand Down
Loading