Skip to content

w512/Texodus

Repository files navigation

Texodus

Texodus is a modern, fast, and beautiful Markdown editor built with Tauri 2 and Vue 3. Designed for performance and a premium user experience, it combines the power of Rust with the flexibility of modern web technologies to provide a native-feeling desktop writing environment with robust support for the GitHub Flavored Markdown (GFM) standard.

Texodus Editor Preview

📥 Installation

Download the latest release from the releases page. It's available for macOS, Windows, and Linux. You can also build it from source.

✨ Features

  • CodeMirror 6 Editor: Modern editing experience with markdown syntax highlighting, smart indentation, and large-document performance.
  • Live Markdown Preview: Real-time, debounced rendering with full GitHub Flavored Markdown (GFM) support — tables, strikethrough, autolinks, and interactive task list checkboxes you can toggle directly in the preview.
  • Mermaid Diagrams: Render flowcharts, sequence diagrams, and other Mermaid graph types inline in the preview, themed to match the active color scheme.
  • Local Images: Embed images with relative (![](images/foo.png)) or absolute filesystem paths — resolved against the open document's directory via Tauri's asset protocol.
  • Export: Save the current document as standalone HTML or PDF.
  • Multi-Document & Multi-Window: Open multiple documents in a new tabbed interface or separate native windows.
  • Auto-Reload: Files are automatically reloaded when they are changed on disk by external programs.
  • Settings Mode: A dedicated settings mode for easier configuration.
  • Dynamic Layouts: Switch between Split View, Focus Mode (editor only), and Preview Only modes.
  • 10 Color Schemes: Default, Solarized, Nord, Monokai, Dracula, GitHub, Catppuccin, Gruvbox, Everforest, and Matrix — each with light and dark variants.
  • Document Statistics: Live word / character / line counts and reading-time estimates.
  • Custom Typography: Curated editor and preview fonts (JetBrains Mono, Iosevka, Inter, Roboto, Merriweather, …), all bundled locally — no network fonts.
  • Native Integration:
    • Full system menu support with keyboard accelerators.
    • Open Recent submenu in the File menu.
    • Drag-and-drop file support.
    • Window state persistence (remembers size, position, and maximized state).
    • Unsaved changes protection.
  • Secure & Fast: Built on Tauri 2 with a strict CSP and a local-first philosophy — no telemetry, no cloud.

📸 Gallery

Preview Only Mode (dark theme)

Preview Only Mode

Split View Mode

Split View

🛠️ Tech Stack

  • Core: Tauri 2 (Rust)
  • Frontend: Vue 3 (Composition API) + Vite
  • Editor: CodeMirror 6
  • State: Pinia
  • Markdown: marked.js compliant with the GitHub Flavored Markdown (GFM) specification, with DOMPurify for sanitization.
  • Diagrams: Mermaid
  • Syntax Highlighting: Prism.js (preview code blocks)
  • Styling: Vanilla CSS (no frameworks) with CSS variables for theming.
  • Package Manager: Bun (recommended)

🚀 Getting Started (for Developers)

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/w512/texodus.git
    cd texodus
  2. Install dependencies:

    bun install
  3. Run the development server:

    bun run tauri dev

📦 Building

To create a production-ready installer for your current platform:

bun run tauri build

Linux builds produce .deb, .AppImage, and .rpm packages; macOS produces .dmg and .app; Windows produces an NSIS installer.

🏗️ Project Structure

  • src/: Vue.js frontend source code.
    • assets/: App icons and static assets.
    • components/: Reusable Vue components.
    • composables/: Shared logic (CodeMirror, native menus, formatting, scroll sync).
    • services/: Core application services (file I/O, export, Mermaid, sanitization).
    • stores/: Pinia state management (editor + settings).
    • themes/: Color scheme definitions and Prism stylesheet.
    • utils/: Path helpers and other small utilities.
  • src-tauri/: Rust backend and Tauri configuration.
  • screenshots/: Application screenshots for documentation.

📄 License

This project is licensed under the GNU General Public License v3 - see the LICENSE file for details.

About

Texodus is a modern, fast, small, and beautiful Markdown viewer and editor

Resources

License

Stars

Watchers

Forks