CODE Editor documentation
This is the main manual for the browser editor and the .NET 10 CODE.Editor.WinForms.TextEditor control, as delivered with 0.4.0-preview.2. It includes the custom preview pipeline and preview-only CSS. The JavaScript component's internal API version is 3, independently of the NuGet version.
The editor provides visual content editing and source editing over a separate document model. The host chooses the storage format, permitted features, toolbar, persistence, and image storage. The WinForms control embeds its web assets in its DLL and exposes typed .NET properties, methods, and events.
This manual supersedes the earlier milestone descriptions wherever they conflict with the current implementation. It distinguishes implemented behavior from remaining acceptance work. This is still a preview implementation, not a promise of full Markdown conformance or completed mobile qualification.
Reviewed against the current layout and recent fixes on 20 October 2026, Hawaii, including explicit Source formatting state, ASP.NET Development startup, and WinForms Assets links. The complete manual is available under docs in Solution Explorer. Files under history/ are archived records and retain historical paths and test counts; they are not current setup instructions.
Start here
The screenshot catalog shows the running browser and WinForms samples in Source and Visual modes, with tables, preview and find/replace. The images use a shared example note and are embedded in the relevant chapters below.
| Your task | Read first | Then read |
|---|---|---|
| Integrate with Olympus or another WinForms application | WinForms quick start | Saving, properties |
| Embed in a website | Web quick start | JavaScript API |
Expand ##currentevents## or style a blog preview |
Preview rendering | Events and types |
| Restrict formatting or require clean Markdown | Formats and policy | Editing |
| Add image paste/drop/upload | Images and clipboard | Host integration |
| Maintain the editor | Architecture | Testing, roadmap |
Complete contents
- Overview and feature map
- Web quick start
- WinForms quick start
- Formats and editing policy
- Editing behavior and keyboard shortcuts
- Lists and tables
- Preview rendering, customization and CSS
- Images and clipboard
- State, selection, history and saving
- JavaScript API reference
- WinForms property reference
- WinForms method reference
- WinForms events, enums and data types
- Web, ASP.NET, Photino and WebView2 integration
- Architecture and maintenance
- Security and performance
- Testing and troubleshooting
- Roadmap and known limitations
Essential integration rules
- Save a validated snapshot, persist its
Value/value, then acknowledge that exact revision. WinFormsEditorTextis a useful synchronous cache, not the complete save protocol. - Change content through commands. The rendered DOM is a view, not the authoritative document or persistence format.
- Choose storage format separately from view mode and source language.
- Preview transformations do not modify the stored document.
- The host must store pasted/dropped image files and return durable URLs.
- Policy diagnostics, unfinished image imports, and active composition may prevent a committed save.
Repository and outputs
Start at the root README. Shared browser source lives under src/CODE.Editor.Web/, and the reusable .NET control under src/CODE.Editor.WinForms/. Build CODE.Editor.sln through ./build/build.ps1. Generated browser files, packages and verification logs live under artifacts/. No external JavaScript editor framework, npm dependency or CDN is required by the runtime.