StepWise.ProseMirror 0.1.14

ProseMirror.Net

[!NOTE] This project is not dead! ProseMirror's core packages see very little change due to maturity; including bug fixes. ProseMirror.Net powers the collaborative editing backend at StepWiseHQ.

The best way to work with ProseMirror document models in DotNet:

• Document and step DTOs for serialization/deserialization
• Building and updating documents server-side
• Server-side schema validation
• Building collaborative editing backends

ProseMirror.Net is a direct translation of the core ProseMirror packages from TypeScript to C#

• prosemirror-model
• prosemirror-transform
• prosemirror-test-builder
• prosemirror-schema-basic
• prosemirror-schema-list

Getting Started

dotnet add package StepWise.ProseMirror

Basic Usage

using StepWise.Prose.Model;

var schemaSpec = new SchemaSpec() {
	Nodes = new()
	{
		["doc"] = new() { Content = "paragraph+" },
		["paragraph"] = new() { Content = "text*" },
		["text"] = new() { }
	},
    Marks = new()
};
var schema = new Schema(schemaSpec);

var doc = schema.Node("doc", null, [
	schema.Node("paragraph", null, [
		schema.Text("Hello World")
	], null)
], null);

Console.WriteLine(doc.ToString()); // doc(paragraph("Hello World"))

Test Builder & Transform

using StepWise.Prose.Model;
using StepWise.Prose.TestBuilder;
using StepWise.Prose.Transformation;

using static StepWise.Prose.TestBuilder.Builder;

Node node = doc(p("Hello <a>"));

var tr = new Transform(node);

tr.ReplaceWith(node.Tag()["a"], node.Tag()["a"], schema.Text("World"));

Console.WriteLine(tr.Doc.ToString()); // doc(paragraph("Hello World"))

Deserializing Steps

using StepWise.Prose.Model;
using StepWise.Prose.TestBuilder;
using StepWise.Prose.Transformation;

using static StepWise.Prose.TestBuilder.Builder;

Node node = doc(p("Hello <a>"));

var stepJsonString = """{"stepType":"replace","from":7,"to":7,"slice":{"content":[{"type":"text","text":"World","marks":[]}]}}""";
var step = Step.FromJSON(Builder.schema, StepDto.FromJson(stepJsonString));

var tr = new Transform(node);
tr.Step(step);

Console.WriteLine(tr.Doc.ToString()); // doc(paragraph("Hello World"))

Deserializing Docs(Nodes)

using StepWise.Prose.Model;
using StepWise.Prose.TestBuilder;

var docJsonString = """{"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Hello World","marks":[]}],"marks":[]}],"marks":[]}""";
var doc = Node.FromJSON(Builder.schema, NodeDto.FromJson(docJsonString));

Console.WriteLine(doc.ToString()); // doc(paragraph("Hello World"))