README.md

Typability

a WYSIWYG markdown editor based on Milkdown. (Thanks to SoilZhu for drawing this icon!)

✨ Features

• 🌈 Fluent Design - Use FluentUI components with Mica\Arcylic background
• 🪶 Lightweight - Bundle with tauri for smaller installer size and memory usage
• 📝 WYSIWYG Markdown - provides Typora-like seamless Markdown editing experience

🚧 Todo

• Multi-language support
• Find/Replace
• LaTeX support
• More export options
• Two-column editor
• Picture bed integration

☔ System Requirements

• Windows 7+ (Recommend: Windows 10 1803 +)
• macOS 11.3+ (Reasons: see Fluent UI's broswer support matrix)
• most Linux distributions (Recommend/Tested: Ubuntu 18.04 +)

📦 How to build

This project is bundled with tauri, You should follow this guide first.

yarn install # Install dependencies
yarn tauri dev # Start development server
yarn tauri build # Bundle App

🌍 Translation

Typability add i18n support since version 0.3.0. Here is the Transifex Project. If you're intersted in translating this project, contact me please!