@hachej/boring-deck 0.1.41 → 0.1.42

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 +7 -20
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -186,10 +186,8 @@ workspace file contexts).
186
186
 
187
187
  - deck files live under `deck/*.md` by default
188
188
  - `---` on its own line splits slides
189
- - widgets use moustache syntax
190
- - inline widgets stay inline; block widgets render as their own block
191
-
192
- Example:
189
+ - widgets use moustache syntax; inline widgets stay inline, block widgets render
190
+ as their own block
193
191
 
194
192
  ```md
195
193
  # Quarterly update
@@ -205,31 +203,20 @@ Welcome {{Badge text="draft"}}
205
203
 
206
204
  ## Widget injection
207
205
 
208
- Widgets stay app-owned. The generic package only provides the registry and
209
- rendering contract.
206
+ Widgets stay app-owned the package only provides the registry and rendering
207
+ contract. Unknown widgets and widget parse/render failures render a visible
208
+ placeholder locally instead of crashing the deck.
210
209
 
211
210
  ```tsx
212
- import { createDeckPlugin } from "@hachej/boring-deck/front"
213
- import type { DeckWidgetDefinition } from "@hachej/boring-deck/shared"
214
-
215
211
  const badgeWidget: DeckWidgetDefinition = {
216
212
  name: "Badge",
217
213
  display: "inline",
218
- render: ({ attrs }) => <span className="rounded-full border px-2 py-0.5 text-xs">{attrs.text}</span>,
214
+ render: ({ attrs }) => <span className="badge">{attrs.text}</span>,
219
215
  }
220
216
 
221
- const deckPlugin = createDeckPlugin({
222
- widgets: [badgeWidget],
223
- theme: {
224
- className: "my-deck-theme",
225
- slideClassName: "my-deck-slide",
226
- },
227
- })
217
+ const deckPlugin = createDeckPlugin({ widgets: [badgeWidget] })
228
218
  ```
229
219
 
230
- Unknown widgets render a visible placeholder instead of crashing the whole deck.
231
- Widget parse/render failures stay local to the widget.
232
-
233
220
  ## Theming
234
221
 
235
222
  Theme customization is intentionally small:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hachej/boring-deck",
3
- "version": "0.1.41",
3
+ "version": "0.1.42",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "description": "Front-only markdown deck plugin scaffold for Boring workspace.",
@@ -48,12 +48,12 @@
48
48
  "lucide-react": "^1.8.0",
49
49
  "react-markdown": "^10.1.0",
50
50
  "remark-gfm": "^4.0.1",
51
- "@hachej/boring-ui-kit": "0.1.41"
51
+ "@hachej/boring-ui-kit": "0.1.42"
52
52
  },
53
53
  "peerDependencies": {
54
54
  "react": "^18.0.0 || ^19.0.0",
55
55
  "react-dom": "^18.0.0 || ^19.0.0",
56
- "@hachej/boring-workspace": "0.1.41"
56
+ "@hachej/boring-workspace": "0.1.42"
57
57
  },
58
58
  "devDependencies": {
59
59
  "@testing-library/jest-dom": "^6.9.1",
@@ -67,7 +67,7 @@
67
67
  "tsup": "^8.0.0",
68
68
  "typescript": "^5.4.0",
69
69
  "vitest": "^3.2.6",
70
- "@hachej/boring-workspace": "0.1.41"
70
+ "@hachej/boring-workspace": "0.1.42"
71
71
  },
72
72
  "scripts": {
73
73
  "build": "tsup",