基于 VuePress 2.x 与 ElementPlus 的组件库文档搭建实践
1. 前言 计划使用 VuePress 2.x 结合 ElementPlus 实现一个封装组件库的文档说明网站。本文将详细介绍如何搭建环境、配置项目以及解决过程中遇到的问题。 2. Vuepress项目初始化 2.1 准备工作 创建一个名为 VuePressTest 的项目目录,然后进入该目录并安装依赖: mkdir VuePressTest && cd VuePressTest npm init -y npm install -D vuepress@next npm install 2.2 配置 在项目根目录下的 package.json 文件中添加以下脚本: { "scripts": { "dev": "vuepress dev docs", "build": "vuepress build docs" } } 2.3 示例 在项目根目录下创建 docs/README.md 文件,并添加以下内容: --- home: true heroImage: https://artice-code-1258339218.cos.ap-beijing.myqcloud.com/vuepress/element-index.png heroText: Element features: - title: 一致性 Consistency details: 与现实生活一致:与现实生活的流程、逻辑保持一致,遵循用户习惯的语言和概念 - title: 反馈 Feedback details: 通过界面样式和交互动效让用户可以清晰的感知自己的操作 - title: 效率 Efficiency details: 界面简单直白,让用户快速识别而非回忆,减少用户记忆负担。 footer: by饿了么 --- 运行 npm run dev 命令后,效果如下: ...