VuePress2.0構(gòu)建項(xiàng)目文檔系統(tǒng)
VuePress2.0構(gòu)建項(xiàng)目文檔系統(tǒng)
參考TerraMours 官網(wǎng)。https://terramours.site/
文件結(jié)構(gòu)參考：
修改項(xiàng)目下的README.md，修改內(nèi)容：
---
home:?true
heroImage:?images/hero.png
heroText:?TerraMours
actions:
??-?text:?快速開始
????link:?/guide/
????type:?primary
??-?text:?演示站點(diǎn)
????link:?http://43.134.164.127:8089/
????type:?secondary
features:
-?title:?簡(jiǎn)潔高效
??details:?TerraMours?采用了?Masa的MinimalAPI，通過極簡(jiǎn)的代碼實(shí)現(xiàn)了高效的?HTTP?API?接口的同時(shí)，提供更高的性能和更低的延遲。
-?title:?領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)(DDD)
??details:?TerraMours?框架實(shí)現(xiàn)領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)(DDD)的落地，提供更好的業(yè)務(wù)識(shí)別和管理，更好的模塊劃分，更好的數(shù)據(jù)映射，更好的維護(hù)性和可擴(kuò)展性。
-?title:?擴(kuò)展開發(fā)
??details:?TerraMours?已經(jīng)實(shí)現(xiàn)了用戶管理、權(quán)限驗(yàn)證、日志管理等基礎(chǔ)功能，開發(fā)者可以根據(jù)業(yè)務(wù)需求快速開發(fā)相關(guān)業(yè)務(wù)系統(tǒng)。
footer:?MIT?Licensed?|?Copyright?(c)?2023?firstsaofan
---
2.修改package.json
添加腳本：
{
??"name":?"TerraMours-Starter",
??"version":?"1.0.0",
??"description":?"",
??"main":?"index.js",
??"homepage":?"https://github.com/vuepress",
??"bugs":?{
????"url":?"https://github.com/vuepress/vuepress-next/issues"
??},
??"repository":?{
????"type":?"git",
????"url":?"git+https://github.com/vuepress/vuepress-next.git"
??},
??"scripts":?{
????"test":?"echo?\"Error:?no?test?specified\"?&&?exit?1",
????"docs:dev":?"vuepress?dev?docs",
????"docs:build":?"vuepress?build?docs"
??},
??"keywords":?[],
??"author":?"",
??"license":?"ISC",
??"devDependencies":?{
????"@vuepress/client":?"2.0.0-beta.62",
????"@vuepress/plugin-docsearch":?"2.0.0-beta.62",
????"vue":?"^3.3.4",
????"vuepress":?"2.0.0-beta.62"
??}
}
3.補(bǔ)全.vuepress
在.vuepress下補(bǔ)全配置文件
1.創(chuàng)建配置文件
在.vuepress文件夾下創(chuàng)建文件config.js，內(nèi)容：
import?{?defaultTheme?}?from?'vuepress'
import?{?docsearchPlugin?}?from?'@vuepress/plugin-docsearch'
import?{?defineUserConfig}?from?'vuepress'
import?{
??navbarEn,
??navbarZh,
??sidebarEn,
??sidebarZh,
}?from?'./configs/index.js'
//?const?isProd?=?process.env.NODE_ENV?===?'production'
const?isProd?=?false
export?default?defineUserConfig({
????//?set?site?base?to?default?value
????base:?'/',
????//?extra?tags?in?`<head>`
????//?head,
????//?site-level?locales?config
????locales:?{
????????'/':?{
??????????lang:?'zh-CN',
??????????title:?'TerraMours',
??????????description:?'TerraMours?開源項(xiàng)目',
????????},
????????'/en/':?{
????????lang:?'en-US',
????????title:?'TerraMours',
????????description:?'TerraMours?FrameWork',
????????},
????},
????//?configure?default?theme
??theme:?defaultTheme({
????logo:?'/images/hero.png',
????repo:?'firstsaofan/TerraMours',
????docsDir:?'docs',
????//?theme-level?locales?config
????locales:?{
??????/**
???????*?English?locale?config
???????*
???????*?As?the?default?locale?of?@vuepress/theme-default?is?English,
???????*?we?don't?need?to?set?all?of?the?locale?fields
???????*/
??????'/':?{
????????//?navbar
????????navbar:?navbarZh,
????????selectLanguageName:?'簡(jiǎn)體中文',
????????selectLanguageText:?'選擇語言',
????????selectLanguageAriaLabel:?'選擇語言',
????????//?sidebar
????????sidebar:?sidebarZh,
????????//?page?meta
????????editLinkText:?'在?GitHub?上編輯此頁',
????????lastUpdatedText:?'上次更新',
????????contributorsText:?'貢獻(xiàn)者',
????????//?custom?containers
????????tip:?'提示',
????????warning:?'注意',
????????danger:?'警告',
????????//?404?page
????????notFound:?[
??????????'這里什么都沒有',
??????????'我們?cè)趺吹竭@來了？',
??????????'這是一個(gè)?404?頁面',
??????????'看起來我們進(jìn)入了錯(cuò)誤的鏈接',
????????],
????????backToHome:?'返回首頁',
????????//?a11y
????????openInNewWindow:?'在新窗口打開',
????????toggleColorMode:?'切換顏色模式',
????????toggleSidebar:?'切換側(cè)邊欄',
??????},
??????/**
???????*?Chinese?locale?config
???????*/
??????'/en/':?{
????????//?navbar
????????navbar:?navbarEn,
????????//?sidebar
????????sidebar:?sidebarEn,
????????//?page?meta
????????editLinkText:?'Edit?this?page?on?GitHub',
??????},
????},
????themePlugins:?{
??????//?only?enable?git?plugin?in?production?mode
??????git:?isProd,
??????//?use?shiki?plugin?in?production?mode?instead
??????prismjs:?!isProd,
????},
??}),
??//?use?plugins
??plugins:?[
????docsearchPlugin({
??????appId:?'34YFD9IUQ2',
??????apiKey:?'9a9058b8655746634e01071411c366b8',
??????indexName:?'vuepress',
??????searchParameters:?{
????????facetFilters:?['tags:v2'],
??????},
??????locales:?{
????????'/':?{
??????????placeholder:?'搜索文檔',
??????????translations:?{
????????????button:?{
??????????????buttonText:?'搜索文檔',
??????????????buttonAriaLabel:?'搜索文檔',
????????????},
????????????modal:?{
??????????????searchBox:?{
????????????????resetButtonTitle:?'清除查詢條件',
????????????????resetButtonAriaLabel:?'清除查詢條件',
????????????????cancelButtonText:?'取消',
????????????????cancelButtonAriaLabel:?'取消',
??????????????},
??????????????startScreen:?{
????????????????recentSearchesTitle:?'搜索歷史',
????????????????noRecentSearchesText:?'沒有搜索歷史',
????????????????saveRecentSearchButtonTitle:?'保存至搜索歷史',
????????????????removeRecentSearchButtonTitle:?'從搜索歷史中移除',
????????????????favoriteSearchesTitle:?'收藏',
????????????????removeFavoriteSearchButtonTitle:?'從收藏中移除',
??????????????},
??????????????errorScreen:?{
????????????????titleText:?'無法獲取結(jié)果',
????????????????helpText:?'你可能需要檢查你的網(wǎng)絡(luò)連接',
??????????????},
??????????????footer:?{
????????????????selectText:?'選擇',
????????????????navigateText:?'切換',
????????????????closeText:?'關(guān)閉',
????????????????searchByText:?'搜索提供者',
??????????????},
??????????????noResultsScreen:?{
????????????????noResultsText:?'無法找到相關(guān)結(jié)果',
????????????????suggestedQueryText:?'你可以嘗試查詢',
????????????????reportMissingResultsText:?'你認(rèn)為該查詢應(yīng)該有結(jié)果？',
????????????????reportMissingResultsLinkText:?'點(diǎn)擊反饋',
??????????????},
????????????},
??????????},
????????},
??????},
????}),
??],
})
2.添加public文件夾
存放一些公共文件，比如圖標(biāo)，xml等
1.添加images文件夾
保存圖片，將logo放在文件夾下
3.添加configs文件夾
存放配置
1.添加navbar文件夾
導(dǎo)航欄配置
1.添加zh.ts(中文配置)
內(nèi)容：
import?type?{?NavbarConfig?}?from?'vuepress'
export?const?navbarZh:?NavbarConfig?=[
????{
????????text:?'指南',
????????link:?'/guide/',
??????},
??????{
????????text:?'項(xiàng)目開發(fā)者',
????????children:?[
??????????{
????????????text:"firstsaofan",
????????????link:"https://www.firstsaofan.top/"
??????????},
??????????{
????????????text:"raokun",
????????????link:"https://www.raokun.top/"
??????????}
????????],
??????},
]
2.添加index.ts（配置引用）
內(nèi)容：
export?*?from?'./en.js'
export?*?from?'./zh.js'
3.添加en.ts（英文配置）
同zh.ts
2.添加sidebar文件夾
側(cè)邊欄配置
1.添加zh.ts(中文配置)
2.添加index.ts（配置引用）
3.添加en.ts（英文配置）
同zh.ts
4.創(chuàng)建md文件
參考結(jié)構(gòu)圖，新增自己的MD文件，然后在sidebar的配置中添加對(duì)應(yīng)的文件路徑配置
5.啟動(dòng)項(xiàng)目命令
pnpm?docs:dev
6.項(xiàng)目展示
參考TerraMours 官網(wǎng)。https://terramours.site/
額外配置：全局查找
https://v2.vuepress.vuejs.org/zh/reference/plugin/docsearch.html
使用方法
pnpm?i?-D?@vuepress/plugin-docsearch@nextimport?{?docsearchPlugin?}?from?'@vuepress/plugin-docsearch'
export?default?{
??plugins:?[
????docsearchPlugin({
??????//?配置項(xiàng)
????}),
??],
}
