Skip to content
⚠️ This article was written in 2022. Some content may be outdated.

VitePress 文檔站搭建實踐

關於VitePress 文檔站搭建實踐,很多開發者只停留在 API 調用層面。本文試圖從生產環境的角度,討論實際中會遇到的問題和解決方案。

基本原理

先來看基本的實現方式:

javascript
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { resolve } from 'path'

export default defineConfig({
  plugins: [vue()],
  resolve: { alias: { '@': resolve(__dirname, 'src') } },
  server: {
    port: 3000,
    proxy: { '/api': { target: 'http://localhost:8080', changeOrigin: true } }
  },
  build: {
    rollupOptions: {
      output: {
        manualChunks: {
          vendor: ['vue', 'vue-router', 'pinia'],
          utils: ['lodash-es', 'dayjs']
        }
      }
    }
  }
})

這段代碼展示了基本的使用方式。實際項目中還需要考慮錯誤處理和邊界條件。

高級特性

在這個基礎上,我們可以進一步優化:

javascript
import { reactive, toRefs, computed } from 'vue'

function useCounter(initial = 0) {
  const state = reactive({ count: initial, history: [initial] })
  const doubled = computed(() => state.count * 2)

  function increment() {
    state.count++
    state.history.push(state.count)
  }

  return { ...toRefs(state), doubled, increment }
}

這種模式在大型項目中非常實用,能顯著降低維護成本。

項目實踐

實際項目中的用法會更復雜一些:

javascript
import { ref, computed, watch, onMounted } from 'vue'

export default {
  setup() {
    const count = ref(0)
    const doubled = computed(() => count.value * 2)

    watch(count, (newVal, oldVal) => {
      console.log(`count: ${oldVal} -> ${newVal}`)
    })

    onMounted(() => { console.log('組件已掛載') })

    return { count, doubled }
  }
}

通過這種方式,代碼的可測試性和可擴展性都得到了提升。

最佳實踐

以下是一個完整的示例:

javascript
module.exports = {
  entry: './src/index.js',
  output: { path: __dirname + '/dist', filename: '[name].[contenthash:8].js' },
  module: {
    rules: [
      { test: /\.jsx?$/, exclude: /node_modules/, use: 'babel-loader' },
      { test: /\.css$/, use: ['style-loader', 'css-loader', 'postcss-loader'] }
    ]
  },
  optimization: {
    splitChunks: {
      chunks: 'all',
      cacheGroups: {
        vendor: { test: /[\\/]node_modules[\\/]/, name: 'vendors' }
      }
    }
  }
}

注意邊界條件處理,這在生產環境中至關重要。

小結

  • 不要為了用新技術而用新技術
  • 代碼示例僅供參考,需根據業務場景調整
  • VitePress 文檔站搭建實踐不是銀彈,需要根據項目規模和技術棧選擇

MIT Licensed