Skip to content
On this page

Vitepress 配置

基本配置檔放在/docs/.vitepress內,需自己新增config.js,主內容如下:

js
// config.js
export default {
    title: 'Here is title',
    titleTemplate:'瀏覽器標籤',
    description: 'first vitepress site',
    cleanUrls: true,
    appearance: true,

    themeConfig:{
      nav:[{...}],
      socialLinks:[{...}],
      sidebar:{...},
      docFooter{...},
      logo:'/*.svg'
    }
  }

常用的幾個標籤:

  • title網站Logo,使用文字來呈現,如果想用圖片,改為logo : '/圖片路徑',就要放在themeConfig

  • titleTemplate瀏覽器頁面標籤。

  • description敘述網站內容,編譯後會成為<meta>標籤。

  • socialLinks掛載github、fb..等等的8個icon連結,會顯示在切換早、晚模式按鈕旁,如果想要添加icon,可到icones去尋找,但僅限.svg檔。

js
// config.js
socialLinks:[
  {icon:'github',link:'https://github.io'},
  {svg:'<svg>',link:'your link'}
]
  • cleanUrls : true | false 生成的Url路徑取消或顯示.html。 cleanUrlno cleanUrl

  • docFooter : { prev : 'Prev page' , next : 'Next page' } 可覆蓋預設英文的上、下頁標籤。 docFooter

  • appearance : true | false 切換白天/暗黑模式的按鍵顯示。 appearanceappearance dark

TIP

有注意到嗎?有幾個標籤是放在themeConfig內,有關版面配置大多會放在這地方。下段就提到相關配置設定。


版面架構

Vitepress區分幾個版面架構,詳細設定可參閱官方說明。

基本上官方的Team PageSearchCarbon Ads都是自己喊爽的,需要外部支援才能擴充,否則依據正常基本安裝是無法執行。


TIP

npm run docs:build開發編譯後如果不指定資料夾,則會在路徑/docs/.vitepress內自動產出/dist資料夾。