Vite Plugin MD 使用教程

Vite Plugin MD 使用教程

vite-plugin-mdMarkdown with Vue for Vite项目地址:https://gitcode.com/gh_mirrors/vi/vite-plugin-md

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

vite-plugin-md/
├── README.md
├── package.json
├── src/
│   ├── index.ts
│   ├── plugin.ts
│   ├── utils.ts
│   └── types.ts
├── examples/
│   ├── basic/
│   │   ├── index.html
│   │   ├── main.js
│   │   └── README.md
│   └── advanced/
│       ├── index.html
│       ├── main.js
│       └── README.md
├── dist/
│   ├── index.js
│   ├── plugin.js
│   ├── utils.js
│   └── types.d.ts
└── tsconfig.json

• README.md: 项目介绍和使用说明。
• package.json: 项目依赖和脚本配置。
• src/: 源代码目录，包含插件的主要逻辑。
  • index.ts: 入口文件。
  • plugin.ts: 插件核心逻辑。
  • utils.ts: 工具函数。
  • types.ts: 类型定义。
• examples/: 示例项目，展示插件的基本和高级用法。
  • basic/: 基本示例。
  • advanced/: 高级示例。
• dist/: 编译后的文件，供生产环境使用。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，它是整个插件的入口点。该文件导入了插件的核心逻辑并将其暴露给外部使用。

import { createPlugin } from './plugin'

export default createPlugin

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 tsconfig.json。

package.json

package.json 包含了项目的依赖、脚本和其他元数据。以下是一些关键部分：

{
  "name": "vite-plugin-md",
  "version": "1.0.0",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "dev": "tsc --watch"
  },
  "dependencies": {
    "vite": "^2.0.0"
  },
  "devDependencies": {
    "typescript": "^4.0.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• main: 入口文件路径。
• scripts: 脚本命令，如 build 和 dev。
• dependencies: 生产环境依赖。
• devDependencies: 开发环境依赖。

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，定义了编译选项和文件包含规则。

{
  "compilerOptions": {
    "target": "esnext",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src"]
}

• compilerOptions: 编译选项。
  • target: 编译目标。
  • module: 模块系统。
  • outDir: 输出目录。
  • strict: 严格模式。
  • esModuleInterop: 模块互操作。
• include: 包含的文件或目录。

vite-plugin-mdMarkdown with Vue for Vite项目地址:https://gitcode.com/gh_mirrors/vi/vite-plugin-md