@railway/inkwell
v0.1.4
Published
Inkwell is a Markdown editor and renderer for React with an extensible plugin system and real-time collaboration support.
Keywords
Readme
✒️ Inkwell
Inkwell is a Markdown editor and renderer for React with an extensible plugin system and real-time collaboration support.
Usage
Installation
pnpm add @railway/inkwellEditor
import { InkwellEditor } from "@railway/inkwell";
import { useState } from "react";
function App() {
const [content, setContent] = useState("# Hello **world**");
return <InkwellEditor content={content} onChange={setContent} />;
}Renderer
import { InkwellRenderer } from "@railway/inkwell";
function App() {
return <InkwellRenderer content="# Hello **world**" />;
}See inkwell.build/docs/quickstart for more details.
Development
pnpm devReleases
Releases are published to npm via GitHub Actions.
cd packages/inkwell
npm version patch --no-git-tag-version # or minor / major
cd ../..
git add packages/inkwell/package.json
git commit -m "🚀 release: v$(node -p "require('./packages/inkwell/package.json').version")"
git tag "v$(node -p "require('./packages/inkwell/package.json').version")"
git push && git push --tagsPushing a v* tag triggers the publish workflow.
