@railway/inkwell 0.1.0 → 0.1.4
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 +68 -0
- package/package.json +6 -1
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# ✒️ Inkwell
|
|
2
|
+
|
|
3
|
+
[](https://inkwell.build)
|
|
4
|
+
[](https://inkwell.build/llms.txt)
|
|
5
|
+
[](https://github.com/railwayapp/inkwell/actions)
|
|
6
|
+
[](https://www.npmjs.com/package/@railway/inkwell)
|
|
7
|
+
|
|
8
|
+
Inkwell is a Markdown editor and renderer for React with an extensible plugin
|
|
9
|
+
system and real-time collaboration support.
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Installation
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
pnpm add @railway/inkwell
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Editor
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
import { InkwellEditor } from "@railway/inkwell";
|
|
23
|
+
import { useState } from "react";
|
|
24
|
+
|
|
25
|
+
function App() {
|
|
26
|
+
const [content, setContent] = useState("# Hello **world**");
|
|
27
|
+
return <InkwellEditor content={content} onChange={setContent} />;
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Renderer
|
|
32
|
+
|
|
33
|
+
```tsx
|
|
34
|
+
import { InkwellRenderer } from "@railway/inkwell";
|
|
35
|
+
|
|
36
|
+
function App() {
|
|
37
|
+
return <InkwellRenderer content="# Hello **world**" />;
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
See [inkwell.build/docs/quickstart](https://inkwell.build/docs/quickstart) for
|
|
42
|
+
more details.
|
|
43
|
+
|
|
44
|
+
## Development
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
pnpm dev
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Releases
|
|
51
|
+
|
|
52
|
+
Releases are published to npm via GitHub Actions.
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
cd packages/inkwell
|
|
56
|
+
npm version patch --no-git-tag-version # or minor / major
|
|
57
|
+
cd ../..
|
|
58
|
+
git add packages/inkwell/package.json
|
|
59
|
+
git commit -m "🚀 release: v$(node -p "require('./packages/inkwell/package.json').version")"
|
|
60
|
+
git tag "v$(node -p "require('./packages/inkwell/package.json').version")"
|
|
61
|
+
git push && git push --tags
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Pushing a `v*` tag triggers the publish workflow.
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
[MIT © 2026 Railway Corporation](LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@railway/inkwell",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Inkwell is a Markdown editor and renderer for React with an extensible plugin system and real-time collaboration support.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -18,6 +18,11 @@
|
|
|
18
18
|
}
|
|
19
19
|
}
|
|
20
20
|
},
|
|
21
|
+
"repository": {
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "https://github.com/railwayapp/inkwell",
|
|
24
|
+
"directory": "packages/inkwell"
|
|
25
|
+
},
|
|
21
26
|
"files": [
|
|
22
27
|
"dist"
|
|
23
28
|
],
|