@brett_lamy/docstream-editor 0.3.0 → 0.3.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 +0 -46
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -11,8 +11,6 @@ TipTap editor components for Docstream GitBook-style markdown documents.
|
|
|
11
11
|
- Conversion helpers between the Docstream AST and TipTap JSON.
|
|
12
12
|
- Slash menu for inserting supported blocks.
|
|
13
13
|
- Code block support through `lowlight`.
|
|
14
|
-
- Live React/JSX/TSX code blocks backed by almost-node.
|
|
15
|
-
- `ReactDemoEditor` for editing and running a complete multi-file project.
|
|
16
14
|
- Table, task list, heading, quote, and inline formatting support.
|
|
17
15
|
- Preserves Docstream/GitBook block semantics when converting back to markdown.
|
|
18
16
|
|
|
@@ -102,53 +100,9 @@ The editor supports common ProseMirror/TipTap content plus GitBook-flavored bloc
|
|
|
102
100
|
- Columns
|
|
103
101
|
- Figures and images
|
|
104
102
|
- OpenAPI operation placeholders
|
|
105
|
-
- Video and public Replay QA previews inside embed blocks
|
|
106
103
|
|
|
107
104
|
Some blocks are intentionally represented as structured nodes rather than fully bespoke editing controls. They are preserved through parse, edit, and serialize flows so the document can continue to round-trip as GitBook-style markdown.
|
|
108
105
|
|
|
109
|
-
### Video and Replay QA embeds
|
|
110
|
-
|
|
111
|
-
Insert an embed block from the slash menu, then enter a direct video URL or a
|
|
112
|
-
public Loop QA project URL. The editor renders video assets through Docstream's
|
|
113
|
-
`VideoEmbed` and converts Loop QA project paths to their chrome-free public
|
|
114
|
-
preview route. The serialized markdown remains portable:
|
|
115
|
-
|
|
116
|
-
```md
|
|
117
|
-
{% embed url="https://loop-qa.replay.io/projects/project-id/tasks/task-id" /%}
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
### Live React code
|
|
121
|
-
|
|
122
|
-
Code blocks can opt into a live preview by setting `live="true"`. The block
|
|
123
|
-
must be a complete entry module (including its `createRoot` call); ordinary
|
|
124
|
-
code snippets remain read-only:
|
|
125
|
-
|
|
126
|
-
````md
|
|
127
|
-
{% code language="jsx" live="true" entry="/src/main.jsx" %}
|
|
128
|
-
```jsx
|
|
129
|
-
import { createRoot } from "react-dom/client"
|
|
130
|
-
createRoot(document.getElementById("root")).render(<h1>Hello</h1>)
|
|
131
|
-
```
|
|
132
|
-
{% endcode %}
|
|
133
|
-
````
|
|
134
|
-
|
|
135
|
-
For multi-file demos, use the standalone editor component:
|
|
136
|
-
|
|
137
|
-
```tsx
|
|
138
|
-
import { ReactDemoEditor } from "@brett_lamy/docstream-editor"
|
|
139
|
-
|
|
140
|
-
<ReactDemoEditor
|
|
141
|
-
files={{
|
|
142
|
-
"/src/main.jsx": mainSource,
|
|
143
|
-
"/src/App.jsx": appSource,
|
|
144
|
-
}}
|
|
145
|
-
entry="/src/main.jsx"
|
|
146
|
-
/>
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
The host app must install `@agent-wasm/core` and expose its service worker with
|
|
150
|
-
`almostnodePlugin()` from `@agent-wasm/core/vite`.
|
|
151
|
-
|
|
152
106
|
## Slash Menu
|
|
153
107
|
|
|
154
108
|
The editor includes a slash menu extension for inserting supported block structures. Type `/` in an empty paragraph to open block insertion options.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brett_lamy/docstream-editor",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "TipTap editor for Docstream GitBook-style markdown documents.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./src/index.ts",
|
|
@@ -35,5 +35,9 @@
|
|
|
35
35
|
"@tiptap/starter-kit": "^3.26.1",
|
|
36
36
|
"@tiptap/suggestion": "^3.26.1",
|
|
37
37
|
"react": ">=18"
|
|
38
|
+
},
|
|
39
|
+
"repository": {
|
|
40
|
+
"type": "git",
|
|
41
|
+
"url": "git+https://github.com/BLamy/docstream-editor.git"
|
|
38
42
|
}
|
|
39
43
|
}
|