Docs GitHub
Free, Open Sourced, MIT Licensed

About Traven

Traven addresses one of the most common challenges web developers face: trying to bring a Typora- or Obsidian-like inline Markdown editing experience to a standard web page or CMS without having to set up a massive NPM build pipeline.


Here's how Traven fits into the broader WYSIWYM ecosystem based on its architecture and design:

1. The Core Engine: Fast & Markdown-native

Traven is built on CodeMirror 6, which easily handles thousands of lines of text without breaking a sweat and is ideal for a Markdown-first, Markdown-native editor.

  • Obsidian’s popular "Live Preview" mode is also built on CodeMirror 6.
  • By choosing CodeMirror 6 rather than building on raw contenteditable (like Vditor) or an HTML-first framework (like ProseMirror), Traven inherits a highly robust, performance-optimized editor state model.
  • CodeMirror 6 was rewritten from the ground up to support modern modular extensions, which is exactly what allows Traven to selectively hide Markdown syntax markers (like ** or _) when they are not actively being edited, and which lets Traven achieve its Typora-like behavior natively in the browser.

2. Single-Tag Web Component Deployment

Unlike many modern WYSIWYM editors that require complex integration into React, Vue, or Svelte, Traven is designed around the Web Components standard.

  • You can drop Traven Editor into any page—whether it's plain HTML, a legacy PHP template, or a Python Django form—using a single <traven-editor> custom element and a CDN <script> tag.
  • This "no build step" philosophy makes it incredibly accessible for developers building traditional server-rendered websites who still want a modern writing experience for their users.

3. Key WYSIWYM Features

Traven packages several features that are usually difficult to implement manually in custom web editors:

Custom Shortcodes

This allows developers to extend standard Markdown with interactive WYSIWYM widgets.

Lazy-Loaded Enhancements

Built-in support for rendering LaTeX math and Mermaid diagrams, while loading these heavy libraries lazily so they don't bloat the initial page load.

Optimistic Media Uploads

Natively supports drag-and-drop or clipboard-paste for images and audio/video, providing visual feedback during the upload process.

Vim Mode

Includes built-in Vim emulation, which is a massive bonus for developers and power users.

4. Philosophy and Naming

The project's nod to the pseudonymous, privacy-focused author B. Traven (author of The Treasure of the Sierra Madre) is a choice based on its philosophy. The editor is designed to be self-hosted, independent, and work quietly under the hood without requiring third-party API keys, logins, or tracking, and the name represents its commitment to independence, privacy, and solid competence.

Traven bridges the gap between the desktop simplicity of Typora/Obsidian and the embeddable requirements of modern web development. This gap is real and massive. It represents the friction between the modern, sleek writing experience users have come to expect from desktop apps like Obsidian, and the painful reality of integrating bloated, framework-heavy editors into traditional server-side web applications.

By building on the robust foundation of CodeMirror 6 and adhering to Web Component standards, Traven is a tool that is powerful but at the same time also accessible to developers regardless of their stack. Features like optimistic media uploads, lazy-loaded LaTeX/Mermaid, and Vim mode are the kind of "quality of life" enhancements that developers value in a library.

Experience Traven Editor

Ready to see how Traven behaves compared to other options? Check out our detailed editor breakdown or try the live dashboard comparison.