寫作背景:
上一篇最終因為版本依賴的不一緻導緻元件文檔站點沒能編譯通過,當時選擇了 vuepress@next,這次重新選擇了 [email protected] 的版本,但還是存在 webpack 的版本依賴問題,是以還是寫一下處理的過程和搭建元件庫文檔站點的過程。
解決方案:
最終的處理很簡單,将對應的包指定版本安裝到項目中,去覆寫掉通過依賴樹導入的包,最終變更的依賴如下:
![](https://img.laitimes.com/img/9ZDMuAjOiMmIsIjOiQnIsICN4ETMfdHLkVGepZ2XtxSZ6l2clJ3LcBnYldHL0FWby9mZvwVPrdEZwZ1Rh5WNXp1bwNjW1ZUba9VZwlHdsAjMfd3bkFGazxCMx8VesATMfhHLlN3XnxCMz8FdsYkRGZkRG9lcvx2bjxSa2EWNhJTW1AlUxEFeVRUUfRHelRHL2EzXlpXazxyayFWbyVGdhd3LcV2Zh1Wa9M3clN2byBXLzN3btg3PwJWZ35yMwYDM4IDZiNGZiZzN0UzNyYzXzAjNwADM3AzLcVDMyIDMy8CXn9Gbi9CXzV2Zh1WavwVbvNmLvR3YxUjLyM3Lc9CX6MHc0RHaiojIsJye.webp)
搭建元件庫站點:
- 安裝 vuepress 依賴:
;yarn add -D vuepress
- 建立說明文檔:
;mkdir docs && echo '# Hello VuePress' > docs/README.md
- 配置指令:
{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}
- 啟動服務:
;yarn docs:dev
增加側邊欄:
- 包含快速啟動;
- 包含 Card 元件介紹;
module.exports = {
themeConfig: {
sidebar: ["/", "/components/card"],
},
};
- /components/card 是card 元件的介紹頁面,檔案類型 md,檔案位置
;docs/components/card.md
在 Markdown 中使用Card 元件:
- 建立放置 Card 元件的目錄:
,預設解析.vue 檔案自動注冊為全局異步元件;docs/.vuepress/components
- 将開發完成的 Card 元件連帶樣式放置到
目錄,并将樣式檔案導入到元件中,元件檔案名按元件 name 字段調整。components
- 元件文檔最少包含三項:樣式示例、代碼示例、屬性說明;
- 編寫 markdown 需要注意制表符會導緻元件渲染失效,需要用空格對代碼進行縮進。
其他的配置:
- 移植元件庫的說明文檔到站點中,替換一開始建立的 markdown 檔案來充當快速入門;
- 為我們的站點添加一個标題到
。docs/.vuepress/config.js
釋出到 Github page:
- 調整站點配置的 base 為對應項目:
;base:"/it200-ui/"
- 建立
釋出腳本;deploy.sh
- 調整 git push 的指令到 it200-ui 項目下的gh-pages分支;
- 運作
開始打包釋出站點;sh deploy.sh
- 推送 github 提示[email protected]: Permission denied (publickey);
- 生成秘鑰:
;ssh-keygen -t rsa -C [email protected]
- 打開公鑰檔案并拷貝内容弄;
- 添加公鑰到 github的
;SSH keys