This project provides a WeChat-optimized Markdown editor designed for users who need to create visually appealing and well-formatted WeChat articles efficiently. It addresses the common pain point of complex formatting in WeChat's backend by offering a clean, intuitive interface that renders Markdown directly into WeChat-compatible rich text, benefiting content creators, bloggers, and anyone publishing on the platform.

How It Works

The editor leverages Vue 3 for its frontend framework, focusing on a minimalist design and a smooth user experience. It supports standard Markdown syntax, including mathematical formulas and Mermaid diagrams, with extensive code block highlighting themes. A key advantage is its flexibility in customization, allowing users to modify theme colors and CSS styles, and its robust support for various image hosting services (e.g., GitHub, Aliyun, Tencent Cloud, Cloudflare R2) with a custom upload option for private services.

Quick Start & Requirements

• Installation: npm i -g @doocs/md-cli
• Prerequisites: Node.js >= 20.
• Running: md-cli (defaults to port 8800). Docker image doocs/md:latest is also available.
• Online Demo: https://md.doocs.org/ (Chrome recommended).

Highlighted Details

• Supports Mermaid diagrams and GFM warning blocks.
• Offers extensive code block syntax highlighting themes.
• Provides multi-image upload with configurable image hosting (9 options including custom).
• Integrates with major AI models for content creation assistance.

Maintenance & Community

The project is actively maintained, with recent updates indicating a move to Vue 3. The project welcomes Pull Requests and discussions. Links to community resources are not explicitly provided in the README, but the project is active on GitHub.

Licensing & Compatibility

The project is licensed under the MIT License, permitting commercial use and integration with closed-source projects.

Limitations & Caveats

The README notes potential styling conflicts with certain browser extensions or user scripts that modify page styles, which may affect rendering or copy-pasting into the WeChat backend. The Vue 2 version is no longer maintained.