@driftime/sanity-plugin-handbook 0.2.0 → 0.2.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.
Files changed (2) hide show
  1. package/README.md +18 -18
  2. package/package.json +1 -4
package/README.md CHANGED
@@ -2,9 +2,9 @@
2
2
 
3
3
  <div align="center">
4
4
  <picture>
5
- <source media="(prefers-color-scheme: dark)" srcset="/.github/assets/icon-dark.svg" />
6
- <source media="(prefers-color-scheme: light)" srcset="/.github/assets/icon.svg" />
7
- <img src="/.github/assets/icon.svg" alt="Handbook icon" width="48" />
5
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/icon-dark.svg" />
6
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/icon.svg" />
7
+ <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/icon.svg" alt="Handbook icon" width="48" />
8
8
  </picture>
9
9
  <h1>Handbook — A Sanity Plugin</h1>
10
10
  <p>Schema-driven documentation and editorial guides, built right into Sanity Studio.</p>
@@ -20,9 +20,9 @@ Handbook adds a dedicated tool to Sanity Studio that serves two purposes: it aut
20
20
 
21
21
  <figure>
22
22
  <picture>
23
- <source media="(prefers-color-scheme: dark)" srcset="/.github/assets/handbook-fields-dark.png" />
24
- <source media="(prefers-color-scheme: light)" srcset="/.github/assets/handbook-fields.png" />
25
- <img src="/.github/assets/handbook-fields.png" alt="The Handbook tool displaying field documentation for a Pages document type, with field names, types, descriptions, and example values" />
23
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-fields-dark.png" />
24
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-fields.png" />
25
+ <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-fields.png" alt="The Handbook tool displaying field documentation for a Pages document type, with field names, types, descriptions, and example values" />
26
26
  </picture>
27
27
  <p align="center"><sub><em>Field documentation generated automatically from your schema definitions.</em></sub></p>
28
28
  </figure>
@@ -72,9 +72,9 @@ This registers a Handbook tool in the Studio navigation. Opening it displays a s
72
72
 
73
73
  <figure>
74
74
  <picture>
75
- <source media="(prefers-color-scheme: dark)" srcset="/.github/assets/handbook-document-types-dark.png" />
76
- <source media="(prefers-color-scheme: light)" srcset="/.github/assets/handbook-document-types.png" />
77
- <img src="/.github/assets/handbook-document-types.png" alt="The Handbook tool showing document type groups in the sidebar with Singletons and Collections listed" />
75
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-document-types-dark.png" />
76
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-document-types.png" />
77
+ <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-document-types.png" alt="The Handbook tool showing document type groups in the sidebar with Singletons and Collections listed" />
78
78
  </picture>
79
79
  <p align="center"><sub><em>Document types organised into groups, browsable from the sidebar.</em></sub></p>
80
80
  </figure>
@@ -153,9 +153,9 @@ The Handbook tool displays guides in the sidebar alongside your document types.
153
153
 
154
154
  <figure>
155
155
  <picture>
156
- <source media="(prefers-color-scheme: dark)" srcset="/.github/assets/handbook-structure-guide-dark.png" />
157
- <source media="(prefers-color-scheme: light)" srcset="/.github/assets/handbook-structure-guide.png" />
158
- <img src="/.github/assets/handbook-structure-guide.png" alt="A guide displayed in the Handbook tool with headings, paragraphs, a callout, a bullet list, and a code block" />
156
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure-guide-dark.png" />
157
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure-guide.png" />
158
+ <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure-guide.png" alt="A guide displayed in the Handbook tool with headings, paragraphs, a callout, a bullet list, and a code block" />
159
159
  </picture>
160
160
  <p align="center"><sub><em>Editorial guides authored with Portable Text and rendered directly in the tool.</em></sub></p>
161
161
  </figure>
@@ -231,9 +231,9 @@ To add handbook documents to the Structure tool sidebar, use the `handbookStruct
231
231
 
232
232
  <figure>
233
233
  <picture>
234
- <source media="(prefers-color-scheme: dark)" srcset="/.github/assets/handbook-structure-dark.png" />
235
- <source media="(prefers-color-scheme: light)" srcset="/.github/assets/handbook-structure.png" />
236
- <img src="/.github/assets/handbook-structure.png" alt="The Handbook singleton editor in the Structure tool, showing reorderable groups each containing guide references" />
234
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure-dark.png" />
235
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure.png" />
236
+ <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure.png" alt="The Handbook singleton editor in the Structure tool, showing reorderable groups each containing guide references" />
237
237
  </picture>
238
238
  <p align="center"><sub><em>The Handbook singleton where groups and their ordering are managed.</em></sub></p>
239
239
  </figure>
@@ -263,9 +263,9 @@ Individual guides are authored as `handbook.guide` documents, which can be creat
263
263
 
264
264
  <figure>
265
265
  <picture>
266
- <source media="(prefers-color-scheme: dark)" srcset="/.github/assets/handbook-structure-guides-dark.png" />
267
- <source media="(prefers-color-scheme: light)" srcset="/.github/assets/handbook-structure-guides.png" />
268
- <img src="/.github/assets/handbook-structure-guides.png" alt="The Handbook Guides list in the Structure tool, showing individual guide documents available for editing" />
266
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure-guides-dark.png" />
267
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure-guides.png" />
268
+ <img src="https://raw.githubusercontent.com/driftime/sanity-plugin-handbook/HEAD/.github/assets/handbook-structure-guides.png" alt="The Handbook Guides list in the Structure tool, showing individual guide documents available for editing" />
269
269
  </picture>
270
270
  <p align="center"><sub><em>Handbook Guides listed in the Structure tool for authoring and editing.</em></sub></p>
271
271
  </figure>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@driftime/sanity-plugin-handbook",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Schema-driven documentation and editorial guides, built right into Sanity Studio.",
5
5
  "keywords": [
6
6
  "sanity",
@@ -85,8 +85,5 @@
85
85
  "eslintImports": false,
86
86
  "scripts": false
87
87
  }
88
- },
89
- "dependencies": {
90
- "@driftime/sanity-plugin-handbook": "file:.yalc/@driftime/sanity-plugin-handbook"
91
88
  }
92
89
  }