Loom.md

A lightweight, fast, and flexible Markdown editor for knowledge-bases and note-taking

Features • Installation • Documentation • Contributing

Features

Markdown Editing

• Live Preview: See your formatted markdown as you type
• Dual Mode: Toggle between editing and preview modes
• Syntax Highlighting: Code blocks with proper syntax support
• Math Support: LaTeX/KaTeX rendering for mathematical expressions
• GFM Support: Full GitHub Flavored Markdown compatibility

File Management

• File Tree Navigation: Visual folder browser with expand/collapse
• Multi-Tab Support: Work on multiple files simultaneously
• Drag & Drop: Drag files and images directly into the editor
• Multi-Select: Select and manage multiple files at once
• Auto-Save: Never lose your work
• File Watcher: Automatic refresh when files change externally

Customization

• Theme System: Built-in dark and light themes
• Custom Themes: Import and create your own themes
• Configurable Settings: Per-folder configuration support
• Keyboard Shortcuts: Fully customizable keybindings

Rich Media

• Image Paste: Paste images directly from clipboard
• Image Drag & Drop: Drop images from file explorer
• Image Preview: Inline image rendering
• Automatic Image Storage: Configurable image save location

Performance

• Instant Startup: Native performance with Tauri
• Low Memory: Efficient Rust backend
• Parallel Rendering: Multi-threaded markdown processing
• Optimized Bundles: Tree-shaken, modular code architecture

Developer-Friendly

• Clean Architecture: Well-organized, maintainable codebase
• TypeScript: Type-safe frontend development
• Modular Design: Single-responsibility modules
• Extensible: Easy to add new features

Installation

Download Pre-built Binaries

(Coming soon)

Download the latest release for your platform from the Releases page.

Build from Source

Prerequisites

• Node.js v18 or higher
• Rust (latest stable)
• Platform-specific dependencies:
  • Linux: webkit2gtk-4.1, libgtk-3-dev, libayatana-appindicator3-dev

    # Ubuntu/Debian
    sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev

  • macOS: Xcode Command Line Tools

    xcode-select --install

  • Windows: WebView2 (usually pre-installed on Windows 10+)

Build Steps

# Clone the repository
git clone https://github.com/Royster0/Loom.md.git
cd Loom.md

# Install dependencies
npm install

# Run in development mode
npm run tauri dev

# Build for production
npm run tauri build

The compiled application will be in src-tauri/target/release/.

Documentation

• User Guide - Comprehensive feature guide
• Development Guide - Setup and workflow
• Architecture - Technical architecture
• Contributing - How to contribute

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Contribution Guide

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests and linting
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Development

# Install dependencies
npm install

# Run in development mode with hot reload
npm run tauri dev

# Build TypeScript
npm run build

# Build the app
npm run tauri build

Tech Stack

• Frontend: TypeScript + HTML + CSS
• Backend: Rust
• Markdown Parser: pulldown-cmark (fast CommonMark parser)
• Math Rendering: KaTeX
• Build Tool: Vite
• Desktop Framework: Tauri 2.0

Planned Features

• Search and replace across files
• Export to PDF/HTML
• Plugin system
• Git integration
• Collaborative editing
• Cloud sync integration
• Advanced markdown extensions
• Custom keyboard shortcut editor
• Command palette
• Split view editing

Known Issues

See the Issues page for known bugs and feature requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with amazing open-source technologies:

• Tauri - Build smaller, faster desktop apps
• pulldown-cmark - Fast CommonMark parser
• KaTeX - Fast math typesetting
• Vite - Next generation frontend tooling

Contact & Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions

⬆ Back to top