使用VitePress搭建及部署vue组件库文档的示例详解_第1页
使用VitePress搭建及部署vue组件库文档的示例详解_第2页
使用VitePress搭建及部署vue组件库文档的示例详解_第3页
全文预览已结束

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

第使用VitePress搭建及部署vue组件库文档的示例详解目录安装vitepress目录结构文档首页配置导航栏配置侧边栏部署到GitHubPages每个组件库都有它们自己的文档。所以当我们开发完成我们自己的组件库必须也需要一个组件库文档。如果你还不了解如何搭建自己的组件库可以看这里-从零搭建Vue3组件库。看完这篇文章你就会发现原来搭建和部署一个组件库文档是那么的简单。当然部署也不需要你有自己的服务器，你只要有github即可。由于我们的组件库还没有完成，所以下面就以element-plus作为示例来搭建一个文档吧。

安装vitepress

首先新建文件夹就叫kittydocs,执行pnpminit初始化，然后安装vitepress

pnpmaddvitepress-D

在package.json添加一些script

"scripts":{

"docs:dev":"vitepressdevdocs",

"docs:build":"vitepressbuilddocs",

"docs:serve":"vitepressservedocs"

}

安装组件库element-plus

pnpmielement-plus-S

目录结构

新建kittydocs目录，其中文件结构如下图

.vitepress/config.js为配置文件.vitepress/theme/index.js为自定义主题examples作为为组件示例目录public是公共文件目录index.md则是组件库文档的首页gulild放我们组件指南文档

文档首页

首先我们按照官网的样式给我们组件库整个首页，在index.md文件中写入

layout:home

title:Kitty

titleTemplate:一个Vue3组件库

hero:

name:Kitty

text:一个Vue3组件库

tagline:没啥特点仅供学习

image:

src:/logo.png

alt:Kitty

actions:

-theme:brand

text:开始

link:/guide/

-theme:alt

text:在Gite

人人文库> 全部分类> 办公材料 > 办公文档

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论