@sanity/dashboard 3.0.0-v3-studio.0 → 3.0.0-v3-studio.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,11 +20,11 @@ The Dashboard itself is mostly concerned about the layout of the configured widg
|
|
|
20
20
|
|
|
21
21
|
In your Sanity Content Studio run:
|
|
22
22
|
|
|
23
|
-
`npm install --save @sanity/dashboard@
|
|
23
|
+
`npm install --save @sanity/dashboard@studio-v3`
|
|
24
24
|
|
|
25
25
|
or
|
|
26
26
|
|
|
27
|
-
`yarn add @sanity/dashboard@
|
|
27
|
+
`yarn add @sanity/dashboard@studio-v3`
|
|
28
28
|
|
|
29
29
|
## Basic usage
|
|
30
30
|
In `sanity.config.js` (or .ts), add the dashboard tool to the createConfig plugins array:
|
|
@@ -175,23 +175,8 @@ If you were previously using @sanity/dashboard in a v2 Sanity Studio, will have
|
|
|
175
175
|
|
|
176
176
|
## Develop & test
|
|
177
177
|
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
```bash
|
|
181
|
-
npm run link-watch
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
In another shell, `cd` to your test studio and run:
|
|
185
|
-
|
|
186
|
-
```bash
|
|
187
|
-
npx yalc add @sanity/dashboard --link && yarn install
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
Now, changes in this repo will be automatically built and pushed to the studio,
|
|
191
|
-
triggering hotreload. Yalc avoids issues with react-hooks that are typical when using yarn/npm link.
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
### About build & watch
|
|
195
|
-
|
|
196
|
-
This plugin uses [@sanity/plugin-sdk](https://github.com/sanity-io/plugin-sdk)
|
|
178
|
+
This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
|
|
197
179
|
with default configuration for build & watch scripts.
|
|
180
|
+
|
|
181
|
+
See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
|
|
182
|
+
on how to run this plugin with hotreload in the studio.
|