yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-27 15:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update ds yarn link docs

Browse Source
This commit is contained in:
Mark Kaylor 2023-04-21 10:37:20 +02:00
parent abb1e3635f
commit 82db28a4d3
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/docs/core/admin/link-strapi-design-system.md
View File

@ -2,24 +2,18 @@
Follow these steps to use a local version of the Strapi design system with the Strapi monorepo
First, run `yarn build` in `strapi-design-system/packages/strapi-design-system` to generate the bundle.
In your copy of the design system run `yarn build` to generate the bundle.
In your copy of Strapi, you can link the design system using either a [relative path](#relative-path) or [yarn link](#yarn-link).
### Relative path
Replace the version number in both `strapi/packages/core/admin/package.json` and `strapi/packages/core/helper-plugin/package.json` with the relative path to your copy of the design system:
In the Strapi monorepo link your local copy of the design system with [`yarn link`](https://yarnpkg.com/cli/link#gatsby-focus-wrapper):
```
"@strapi/design-system": "link:../../../../strapi-design-system/packages/strapi-design-system"
yarn link -r ../<relative-path-to-strapi-design-system>
```
### Yarn link
Running yarn build in `examples/getstarted` should now use your local version of the design system.
Alternatively, you can use [`yarn link`](https://classic.yarnpkg.com/lang/en/docs/cli/link/) by first running `yarn link` in `strapi-design-system/packages/design-system` and then `yarn link @strapi/design-system` in both `strapi/packages/core/admin` and `strapi/packages/core/helper-plugin`. With this approach, no changes need to be made to the `package.json`
Once the link is setup, run the following command from the root of the monorepo
To revert back to the released version of the design system use [`yarn unlink`](https://yarnpkg.com/cli/unlink#usage):
```
yarn clean && yarn setup
yarn unlink ../<relative-path-to-strapi-design-system>
```