markdown-online-editor

This repository contains the source code for Arya, an online Markdown editor built with Vue 2 and the Vditor editor component. Markdown is a lightweight text formatting system where you write plain text with simple symbols for headings, bold, lists, and links, and the editor converts it to formatted output. Arya runs in a web browser and provides a live preview as you type.

The README is written in Chinese and describes a feature list built on top of what Vditor provides. The editor supports flowcharts, Gantt charts, sequence diagrams, and task lists as embedded diagram types within a document. It also supports Echarts data charts, musical staff notation, and PPT-style slide preview using Reveal.js, where horizontal slides are separated by three dashes and vertical slides by two dashes. HTML content pasted into the editor can be converted automatically to Markdown. Files can be exported as styled PDFs, PNG images, JPEG images, or Word documents.

Content is saved to local browser storage to prevent accidental loss. The editor offers three display modes: a what-you-see-is-what-you-get mode, an instant render mode, and a split-screen mode with the source on one side and the preview on the other. Emoji can be inserted directly, and the editor checks and formats Markdown syntax for consistency.

Deployment options include running the built files with PM2 (a Node.js process manager), using Docker with a pre-built image available on Docker Hub, deploying through Docker Compose, or hosting the static build output on Cloudflare Pages or GitHub Pages without any server required. Development requires Node.js version 16 or 17 and yarn or pnpm as the package manager.

The project is available under the MIT license and was created as a personal project to build a free, full-featured Markdown editor after the author found existing editors either incomplete or behind paywalls.