markdown online editor Download - markdown online editor Source code download

markdown online editor

Other resources

1.0.0

Download

Arya - Online Markdown Editor

The online Markdown editor built based on Vue2 and Vditor supports drawing flow charts, Gantt charts, timing charts, task lists, echarts charts, quintuples, as well as PPT preview, video and audio parsing, and automatic HTML conversion to Markdown. markdown.lovejade.cn.

Background original intention

Early on, I noticed Vditor produced by黑客派: a next-generation Markdown editor built for the future. However, the Markdown editors on the market now have more or less problems (or incomplete functions, or premium features charges...). Therefore, based on one's own needs and the power of Vditor, the idea of making an online Markdown editor was born; it was named Arya (Erya).

Functional support

How to use

Clear the current default document in the Arya editing area and you can use it.

The default is WYSIWYG mode, which can be switched through ⌘-⇧-M ( Ctrl-⇧-M ); or through the following methods:

What you see is what you get: ⌘-⌥-7 ( Ctrl-alt-7 );
Instant rendering: ⌘-⌥-8 ( Ctrl-alt-8 );
Split screen rendering: ⌘-⌥-9 ( Ctrl-alt-9 );

PPT Preview

If you use it as a PPT preview (the entry is in设置), you need to note that renderings of various charts cannot be supported here yet; you can use --- to define slides in the horizontal direction, and use -- to define vertical slides. For more settings, please refer to the RevealJs document.

How to deploy?

Deployment with pm2

PM2 is a powerful production environment process manager that not only supports starting applications through the command line, but also uses configuration files (usually called ecosystem.config.js ) to manage complex deployment scenarios. You can achieve rapid deployment by executing the following command:

 # ? 克隆项目
git clone https://github.com/nicejade/markdown-online-editor.git
cd markdown-online-editor

# ➕ 安装依赖
yarn
yarn global add pm2

# ? 构建产物
yarn build

#  部署服务
cd dist
npx pm2 start " npx http-server -p 8866 " --name " markdown-editor "

Docker self-hosted

The latest version has been packaged with Docker and uploaded to Docker Hub, which can be used as follows:

docker run -d -p [Your-Specified-Port]:80 nicejade/markdown-online-editor:[tagname]

# 示例：
docker run -d -p 8866:80 nicejade/markdown-online-editor:latest

Based on the above example, if you execute locally, you can access it by opening the URL - http://localhost:8866. If running on the server, you can access it via http://[Server-IP]:8866. For the process of building a Docker image, see: How to build a docker image for the markdown-online-editor service? . You can also host compiled products (contents under dist directory) through Cloudflare Pages or Github Pages, so as to enable rapid deployment without servers .

Or use docker compose :

Create a docker-compose.yml file and define the service in it (where version: '3' specifies the version of the Docker Compose file; you can adjust it according to the actual situation):

 version : ' 3 '
services :
  markdown-editor :
    image : nicejade/markdown-online-editor:2.1.0
    ports :
      - " 8866:80 "
    restart : always

In the directory containing the docker-compose.yml file, run the following command to start the service:

docker-compose up -d

This will start the service in the background and the effect is the same as the docker run command below. Using Docker Compose allows for easier management of multiple containers and more readable and maintenance configurations.

How to develop

Prerequisites

Explain some prerequisites that users need to prepare before installing and using it, such as: you need to install or upgrade Node.js (>= 16.* , < 18.* ), and it is recommended to use Pnpm or Yarn as the preferred package management tool.

 # ? 克隆项目
git clone https://github.com/nicejade/markdown-online-editor.git
cd markdown-online-editor

# ➕ 安装依赖
yarn

# ? 开始开发
yarn start

#  部署 Github Pages(需修改 commands/deploy.sh)
yarn deploy

Special thanks

Arya is born thanks to Vditor: a browser-side Markdown editor, and it also cannot be separated from the support of open source libraries such as Vue and reveal.js. Thank you?