Get started with Document Authoring guides
Welcome to the Document Authoring developer guides. These cover the information you’ll need to get started with Document Authoring, including using the library methods, editing documents programmatically with transactions, adding AI-assisted editing, and configuring your web app(s) appropriately. In the future, these guides will be expanded with more in-depth walkthroughs.
If you’re new to Document Authoring, refer to our getting started guides to quickly add authoring to your application. You can also clone our examples repo(opens in a new tab) on GitHub to see various options.
The core Document Authoring library is intended to be used in-browser. It’s written in TypeScript and uses some WebAssembly technology, so it can be used without a server, plugins, or even internet access (if self-hosted, rather than using our CDN). Document Authoring AI is optional and uses your own server and model provider while keeping document reads, validation, and writes bound to the live browser editor.
For the core editor, a server-free solution has the following advantages:
- Get up and running faster — No backend servers need to be deployed or maintained.
- Lower infrastructure costs — Rendering and processing are offloaded to the client.
- Security and privacy — Documents don’t need to be transferred across the network to a third party.
Guides
Working with documents
Manage, create, edit, import, and export documents in multiple formats.
Spellcheck
Enable in-editor spellchecking, switch languages at runtime, and support self-hosted dictionary assets.
Comments
Set review authors, add comments to selected text, and manage threaded comment discussions.
Tracked changes and editor modes
Switch between edit, review, and view modes, and create tracked revisions during review workflows.
Actions and toolbar customization
Customize built-in actions, add custom actions, and control which toolbar items appear in the editor.
Events and integration
Listen for document lifecycle events, switch documents, and wire the editor into autosave and cleanup flows.
Copy/paste and HTML interoperability
Use rich clipboard workflows, paste plain text when needed, and understand how HTML-based clipboard interchange works.
AI
Build agentic document assistants or bounded workflows for proofreading, translation, template generation, and reviewable AI edits.
CSP/firewall rules
Define and enforce your security policies on assets hosted on our content delivery network (CDN).
Self-hosting assets
Deploy and maintain assets on your own infrastructure for full control and offline capabilities.