Markdown Online Editor 使用教程

Markdown Online Editor 使用教程

markdown-online-editor📝基于 Vue、Vditor，所构建的在线 Markdown 编辑器，支持流程图、甘特图、时序图、任务列表、HTML 自动转换为 Markdown 等功能；🎉新增「所见即所得」编辑模式。项目地址:https://gitcode.com/gh_mirrors/ma/markdown-online-editor

1. 项目的目录结构及介绍

markdown-online-editor/
├── public/
│   ├── index.html
│   └── favicon.ico
├── src/
│   ├── assets/
│   ├── components/
│   ├── layouts/
│   ├── pages/
│   ├── plugins/
│   ├── router/
│   ├── store/
│   ├── utils/
│   ├── App.vue
│   ├── main.js
│   └── registerServiceWorker.js
├── .env
├── .gitignore
├── babel.config.js
├── package.json
├── README.md
└── vue.config.js

目录结构介绍

• public/: 存放静态资源文件，如 index.html 和 favicon.ico。
• src/: 项目的主要源代码目录。
  • assets/: 存放静态资源，如图片、样式文件等。
  • components/: 存放 Vue 组件。
  • layouts/: 存放页面布局组件。
  • pages/: 存放页面组件。
  • plugins/: 存放 Vue 插件。
  • router/: 存放 Vue Router 配置。
  • store/: 存放 Vuex 状态管理配置。
  • utils/: 存放工具函数。
  • App.vue: 项目的根组件。
  • main.js: 项目的入口文件。
  • registerServiceWorker.js: 用于注册 Service Worker。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• babel.config.js: Babel 配置文件。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• vue.config.js: Vue CLI 配置文件。

2. 项目的启动文件介绍

main.js

main.js 是项目的入口文件，负责初始化 Vue 实例并挂载到 DOM 中。

import Vue from 'vue';
import App from './App.vue';
import router from './router';
import store from './store';
import './registerServiceWorker';

Vue.config.productionTip = false;

new Vue({
  router,
  store,
  render: h => h(App)
}).$mount('#app');

registerServiceWorker.js

registerServiceWorker.js 用于注册 Service Worker，实现离线访问等功能。

if (process.env.NODE_ENV === 'production') {
  require('@/registerServiceWorker');
}

3. 项目的配置文件介绍

.env

.env 文件用于配置环境变量，如 API 地址、密钥等。

VUE_APP_API_URL=http://example.com/api

vue.config.js

vue.config.js 是 Vue CLI 的配置文件，可以自定义 Webpack 配置等。

module.exports = {
  devServer: {
    proxy: 'http://localhost:3000'
  }
};

babel.config.js

babel.config.js 是 Babel 的配置文件，用于配置 JavaScript 转译规则。

module.exports = {
  presets: [
    '@vue/cli-plugin-babel/preset'
  ]
};

package.json

package.json 文件包含了项目的依赖、脚本命令等信息。

{
  "name": "markdown-online-editor",
  "version": "1.0.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "vue": "^2.6.11",
    "vue-router": "^3.2.0",
    "vuex": "^3.4.0"
  },
  "devDependencies": {
    "@vue/cli-plugin-babel": "^4.5.0",
    "@vue/cli-plugin

markdown-online-editor📝基于 Vue、Vditor，所构建的在线 Markdown 编辑器，支持流程图、甘特图、时序图、任务列表、HTML 自动转换为 Markdown 等功能；🎉新增「所见即所得」编辑模式。项目地址:https://gitcode.com/gh_mirrors/ma/markdown-online-editor