Vue Markdown 编辑器使用教程

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

Vue Markdown 编辑器的目录结构如下：

vue-markdown-editor/
├── src/
│   ├── assets/
│   ├── components/
│   ├── plugins/
│   ├── styles/
│   ├── App.vue
│   ├── main.js
├── public/
│   ├── index.html
├── package.json
├── README.md

目录结构介绍

• src/: 源代码目录，包含了所有的 Vue 组件和应用逻辑。
  • assets/: 存放静态资源文件，如图片、字体等。
  • components/: 存放 Vue 组件文件。
  • plugins/: 存放插件文件。
  • styles/: 存放样式文件。
  • App.vue: 主应用组件。
  • main.js: 应用的入口文件。
• public/: 公共资源目录，包含 index.html 文件。
• package.json: 项目的配置文件，包含了依赖包和脚本命令。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 main.js，其主要作用是初始化 Vue 应用并挂载到 DOM 上。

import { createApp } from 'vue';
import App from './App.vue';
import VueMarkdownEditor from '@kangc/v-md-editor';
import '@kangc/v-md-editor/lib/style/base-editor.css';
import vuepressTheme from '@kangc/v-md-editor/lib/theme/vuepress.js';
import '@kangc/v-md-editor/lib/theme/style/vuepress.css';
import Prism from 'prismjs';
import 'prismjs/components/prism-json';

VueMarkdownEditor.use(vuepressTheme, { Prism });

const app = createApp(App);
app.use(VueMarkdownEditor);
app.mount('#app');

启动文件介绍

• 导入依赖: 导入了 Vue、VueMarkdownEditor 和其他必要的样式和主题。
• 使用主题: 使用了 vuepressTheme 主题，并配置了 Prism 代码高亮。
• 创建应用: 使用 createApp 创建 Vue 应用实例。
• 挂载应用: 将应用挂载到 DOM 的 #app 元素上。

3. 项目的配置文件介绍

项目的配置文件是 package.json，其包含了项目的依赖、脚本命令和其他配置信息。

{
  "name": "vue-markdown-editor",
  "version": "1.0.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "core-js": "^3.6.5",
    "@kangc/v-md-editor": "^2.0.0",
    "vue": "^3.0.0"
  },
  "devDependencies": {
    "@vue/cli-plugin-babel": "~4.5.0",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/cli-service": "~4.5.0",
    "babel-eslint": "^10.1.0",
    "eslint": "^6.7.2",
    "eslint-plugin-vue": "^7.0.0"
  },
  "eslintConfig": {
    "root": true,
    "env": {
      "node": true
    },
    "extends": [
      "plugin:vue/vue3-essential",
      "eslint:recommended"
    ],
    "parserOptions": {
      "parser": "babel-eslint"
    },
    "rules": {}
  },
  "browserslist": [
    "> 1%",
    "last 2 versions",
    "not dead"
  ]
}

配置文件介绍

• scripts: 定义了项目的脚本命令，如 serve