Solution · Documents
One block model behind the editor, the reader and every export. Each edit can be undone, and Markdown, DOCX and PDF come from the same source.
Status: in development
Try this
Use Reset to return to the starting example.
Lumen is a fictional note-taking app. This report sums up the quarter for the team.
Offline mode shipped to every workspace.
Search results now load in one round trip.
Every dialog passed a keyboard-only review.
The numbers below are sample data, not real usage.
The metrics block renders in the interactive demo.
The report preview is ready; editing tools load when you start.
If the interactive demo cannot load, use the static preview above.
Each change is a typed operation with an exact inverse, kept in one op log, so undo and redo always work. The editor adds a slash menu of every block type and block drag with keyboard equivalents.
A read-only reader gives headings anchors and an outline. The paged view lays the same document out on real pages with headers and footers, and prints one sheet per page. Editing in the paged view is planned.
Import and export Markdown, and write DOCX and PDF with writers Texuli owns. Every format comes from the same block document, so nothing is converted by hand.
Compose typed blocks with persisted ids, or load a document from an agent or a file through the untrusted loader.
Package: @texuli/document
Every change is a typed operation with an exact inverse in one op log, so undo and redo share one history.
Package: @texuli/document
A formatting toolbar, a link dialog, safe paste, and Markdown in and out.
Package: @texuli/editor
The page editor adds a slash menu and block drag with keyboard equivalents; the reader shows the result read-only, with an outline.
Package: @texuli/pages
Markdown, DOCX and PDF from writers Texuli owns; the pages export entry hands the file to the browser.
Package: @texuli/document
The CRDT sync core merges edits from several replicas; the collaborative editor adds comments, suggestions and version history. Your app supplies the transport.
Package: @texuli/document
Solution
Documents
Packages
@texuli/pagesEditor, reader, exports and collaboration surfacesSubpaths: ./editor · ./reader · ./export · ./collab@texuli/editorRich text surface inside the document editorSubpaths: ./editor · ./markdown@texuli/documentDocument model, operations, Markdown, pagination, DOCX and PDF writers, syncSubpaths: ./model · ./ops · ./markdown · ./paged · ./docx · ./pdf · ./syncBuilt on
@texuli/player (Blueprint player)@texuli/blocks (Content blocks)texuli (Styled components)@texuli/tokens (Theme tokens)@texuli/primitives (Headless primitives)@texuli/core (Texels and the URL policy)@texuli/deck (Deck model and engine)@texuli/drag (Drag engine)
Build with Documents
pnpm add @texuli/document @texuli/pages @texuli/editor @texuli/tokensimport { createDocument, paragraphBlock } from '@texuli/document/model';
import { applyOperations } from '@texuli/document/ops';
import { documentToMarkdown } from '@texuli/document/markdown';
const doc = createDocument({
meta: { title: 'Release notes' },
blocks: [paragraphBlock('p1', 'Shipped the new editor.')],
});
const edit = applyOperations(doc, [
{ op: 'insert-text', id: 'p1', offset: 0, text: 'Today: ' },
]);
if (edit.ok) {
console.log(documentToMarkdown(edit.document));
}
import { loadUntrustedDocument } from '@texuli/document/schema';
const result = loadUntrustedDocument({
"format": "texuli-document",
"formatVersion": 1,
"meta": {
"title": "Release notes",
"locale": "en"
},
"blocks": [
{
"id": "p1",
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Shipped the new editor.",
"marks": []
}
]
}
]
});
if (result.ok) {
console.log(result.document.blocks.length);
}
<script lang="ts">
import { createDocument, paragraphBlock } from '@texuli/document/model';
import { PageEditor } from '@texuli/pages/editor';
import '@texuli/tokens/base.css';
let doc = $state.raw(
createDocument({
meta: { title: 'Release notes' },
blocks: [paragraphBlock('p1', 'Shipped the new editor.')],
}),
);
</script>
<PageEditor document={doc} onChange={(next) => (doc = next)} />
Verified by apps/website/tests/solutions/documents-quickstart.test.ts
Mount the editor and the reader on one document, step by step in the Documents docs.
Use @texuli/document on its own: operations with undo, Markdown in and out, and the owned DOCX and PDF writers.
Add @texuli/pages from npm (pre-1.0, in development).
Agents write a document as data, edit it with bounded patches, and convert it to and from Markdown. The packages are in development.
document.rundocument.run: In developmentMCP operation: validate, inspect, patch and convert a document, from Markdown and to Markdown.
document.exportdocument.export: In developmentMCP operation on the local server: write a document as PDF or DOCX bytes.
documentdocument: In developmentCatalog component that carries a whole document inside a blueprint.
skills/texuli/blueprints/references/documents.mdskills/texuli/blueprints/references/documents.md: In developmentSkill reference for documents as data and their patches.
Svelte 5 packages published on npm (pre-1.0).
Kotlin Multiplatform renderer on the JVM, built in this repository.
Native renderer target.
Native renderer target.
Edit, read, paginate and export block documents.
