使用VitePress搭建及部署vue組件庫(kù)文檔的示例詳解_第1頁(yè)
使用VitePress搭建及部署vue組件庫(kù)文檔的示例詳解_第2頁(yè)
使用VitePress搭建及部署vue組件庫(kù)文檔的示例詳解_第3頁(yè)
全文預(yù)覽已結(jié)束

下載本文檔

版權(quán)說(shuō)明：本文檔由用戶提供并上傳，收益歸屬內(nèi)容提供方，若內(nèi)容存在侵權(quán)，請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

第使用VitePress搭建及部署vue組件庫(kù)文檔的示例詳解目錄安裝vitepress目錄結(jié)構(gòu)文檔首頁(yè)配置導(dǎo)航欄配置側(cè)邊欄部署到GitHubPages每個(gè)組件庫(kù)都有它們自己的文檔。所以當(dāng)我們開(kāi)發(fā)完成我們自己的組件庫(kù)必須也需要一個(gè)組件庫(kù)文檔。如果你還不了解如何搭建自己的組件庫(kù)可以看這里-從零搭建Vue3組件庫(kù)。看完這篇文章你就會(huì)發(fā)現(xiàn)原來(lái)搭建和部署一個(gè)組件庫(kù)文檔是那么的簡(jiǎn)單。當(dāng)然部署也不需要你有自己的服務(wù)器，你只要有g(shù)ithub即可。由于我們的組件庫(kù)還沒(méi)有完成，所以下面就以element-plus作為示例來(lái)搭建一個(gè)文檔吧。

安裝vitepress

首先新建文件夾就叫kittydocs,執(zhí)行pnpminit初始化，然后安裝vitepress

pnpmaddvitepress-D

在package.json添加一些script

"scripts":{

"docs:dev":"vitepressdevdocs",

"docs:build":"vitepressbuilddocs",

"docs:serve":"vitepressservedocs"

}

安裝組件庫(kù)element-plus

pnpmielement-plus-S

目錄結(jié)構(gòu)

新建kittydocs目錄，其中文件結(jié)構(gòu)如下圖

.vitepress/config.js為配置文件.vitepress/theme/index.js為自定義主題examples作為為組件示例目錄public是公共文件目錄index.md則是組件庫(kù)文檔的首頁(yè)gulild放我們組件指南文檔

文檔首頁(yè)

首先我們按照官網(wǎng)的樣式給我們組件庫(kù)整個(gè)首頁(yè)，在index.md文件中寫(xiě)入

layout:home

title:Kitty

titleTemplate:一個(gè)Vue3組件庫(kù)

hero:

name:Kitty

text:一個(gè)Vue3組件庫(kù)

tagline:沒(méi)啥特點(diǎn)僅供學(xué)習(xí)

image:

src:/logo.png

alt:Kitty

actions:

-theme:brand

text:開(kāi)始

link:/guide/

-theme:alt

text:在Gite

溫馨提示

  • 1. 本站所有資源如無(wú)特殊說(shuō)明，都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等，如果需要附件，請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙，網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽，若沒(méi)有圖紙預(yù)覽就沒(méi)有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間，僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理，對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯，并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容，請(qǐng)與我們聯(lián)系，我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論