Cherry Editor

About

## Overview

A lightweight Markdown editor browser extension designed for users who need to efficiently and conveniently edit and save Markdown documents. The extension runs
entirely locally, requiring no internet connection to use, and supports sidebar opening functionality, providing a seamless user experience.

Powered by [cherry-markdown](https://github.com/Tencent/cherry-markdown)

## ✅ Typical Use Cases

- Quickly jot down ideas or extract key information while browsing the web.
- Write technical documentation and export it as PDF or HTML for publishing.
- Utilize the Mermaid chart feature to create flowcharts, structure diagrams, and other visual aids.

## Core Features

### 1. **Local Storage, Data Security**

- All document content is saved on the user's local device, with persistent storage implemented via `IndexedDB`.
- Data remains offline, eliminating privacy risks.

### 2. **Support for Sidebar Opening**

- The extension allows the editor to be opened in the sidebar (`sidepanel`) by clicking the browser extension icon, enabling users to take quick notes or edit
  documents while browsing the web.
- Optimized for small-screen devices, with automatic layout adjustments, full-screen preview, and toggle buttons for collapsing/expanding.

### 3. **Multi-language Support**

- Built-in internationalization support (i18n), currently supporting Chinese (zh-CN) and English (en), with easy expansion to other languages in the future.
- Clear and user-friendly translations, making the interface suitable for global users.

### 4. **Rich Markdown Support**

- Supports standard Markdown syntax, including headings, lists, blockquotes, code blocks, tables, and more.
- Advanced syntax such as info panels (info/warning/danger), accordion folding, table of contents generation (`[[toc]]`), and custom font styles (italic, bold,
  underline, strikethrough, superscript, subscript) are also fully supported.
- Supports Mermaid chart syntax (flowcharts, pie charts, etc.), enhancing document visualization capabilities.

### 5. **Export Functionality**

- Allows documents to be exported in multiple formats:
    - PDF
    - HTML
    - Image (.png)
    - Markdown (.md)
- Export operations are simple and can be completed with a single click, making them ideal for sharing, backup, or publishing needs.

### 6. **Personalization Settings**

- Provides a settings interface where users can configure default behaviors, such as:
    - Action upon clicking the browser icon (opening the sidebar or a new page)
    - Setting the default view mode (edit, preview, split-screen)
- Clear version information is displayed, helping users identify their current version.

### 7. **Responsive Design**

- The interface adopts a responsive layout, adapting to screens of various sizes, with particular optimization for mobile devices.
- Full-screen preview is supported on small screens, enhancing the user experience on mobile devices.