editary

日本語版 (README.ja.md)

editary is a Typora-inspired Markdown editor with a bold Neo-brutalism aesthetic. Built on the cutting-edge Electrobun (Bun-based desktop framework), it delivers a high-performance typing experience and a modern UI.

✨ Features

• Typora-like Writing Experience: Seamlessly edit Markdown with a real-time preview powered by Tiptap.
• Neo-brutalism UI: A bold, high-contrast design with thick borders and vibrant colors.
  • App Window Frame: High-impact black borders around the entire application.
  • Refined Settings: Optimized vertical layouts for better usability.
  • Customizable Themes: Switch between light and dark modes with unique neo-brutalist palettes.
  • Sidebar Navigation: Intuitive file management with a clean, border-heavy aesthetic.
• Advanced Markdown Support:
  • 📊 Mermaid: Create diagrams and charts directly in your notes.
  • 🧪 KaTeX: High-quality math typesetting for formulas.
  • 📝 Task Lists: Manage your TODOs with interactive checkboxes.
  • 🧮 Tables: Rich table editing with a simple interface.
• Modern Tech Stack: Leveraging the speed of Bun and the flexibility of Electrobun.
• Search & Replace: Efficiently find and modify content within your documents.

🛠 Tech Stack

• Framework: Electrobun (Native WebView + Bun Runtime)
• Runtime: Bun
• Editor: Tiptap
• Visuals: Mermaid, KaTeX
• Build: electrobun-builder (NSIS/WiX installers)

🚀 Getting Started

Prerequisites

• Bun installed on your system.

Build and Run

1. Clone the repository:

   git clone https://github.com/Catharacta/editary.git
   cd editary

2. Install dependencies:

   bun install

3. Run in development mode:

   bun start

4. Build the installer (Windows):

   bun run build:installer

📦 Downloads

Check out the Releases page for the latest Windows installers (.exe and .msi).

📄 License

This project is licensed under the MIT License.