vitepress-template

在线演示

🚀 特性

• 自动生成导航栏与侧边栏
• UI集成
  • 组件库：element-plus
  • 原子化CSS：TailwindCSS
  • SVG图标（自动拉取iconfont）
• 组件自动注册
• 自定义vite配置
• 全局布局自定义
• 返回顶部
• 图片缩放
• 支持在Chrome中安装应用

✈️ 下载并使用

下载

git clone https://github.com/shoppingzh/vitepress-template.git

使用时，请对以下内容进行修改：

• 打开 docs/.vitepess/config.ts，修改：
  • title：网站标题
  • themeConfig 默认主题配置
    • nav：导航栏
    • sidebar：侧边栏
    • editLink：编辑链接
• 替换 docs/public/logo.svg 文件
• 重写 docs/index.md，设计自己的首页
• 修改 docs/public/manifest.webmanifest 配置
• 根据需要删除无用文档，新增自己的文档

升级记录

• 2023/07/07 优化图片插件触发时机
  • 升级vitepress至1.0.0-beta.5版本
  • 优化medium-zoom的触发时机，从路由变化改为调用 onContentUpdated 钩子
• 2024/01/15
  • 升级vitepress版本(1.0.0-rc.37)
  • 新增编辑链接配置
  • 新增搜索配置
• 2024/06/27
  • 升级vitepress版本(1.2.3)
  • 去掉《使用技巧》页面
  • 合并vite配置到vitepress配置中
  • 其他优化