Skip to content

vitepress 介绍

vitepress 是一个基于 Vue.js 3.0 的静态网站生成器,用于构建现代化的文档网站。它提供了简单而强大的工具,帮助你快速创建和部署静态网站。

安装和使用

要安装 vitepress,你可以使用 npm 或 yarn。打开终端并运行以下命令:

bash
npm install -D vitepress

或者

bash
yarn global add vitepress

在 .md 文档中使用 Element Plus

  1. 安装依赖(本项目已安装可跳过)
bash
npm i element-plus @element-plus/icons-vue
  1. 注册 Element Plus(在 docs/.vitepress/theme/index.js
js
import DefaultTheme from 'vitepress/theme'
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
import * as ElementPlusIconsVue from '@element-plus/icons-vue'

export default {
  ...DefaultTheme,
  enhanceApp({ app }) {
    DefaultTheme.enhanceApp?.({ app })
    app.use(ElementPlus)

    for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
      app.component(key, component)
    }
  }
}
  1. 在 Markdown 页面直接使用
md
<el-button type="primary">默认按钮</el-button>
<el-icon><Edit /></el-icon>