Skip to main content

Command Palette

Search for a command to run...

用 VuePress 製作說明文件頁面 — 4:佈景主題、外掛

Published
1 min readView as Markdown
用 VuePress 製作說明文件頁面 — 4:佈景主題、外掛
L

前端工程師 Augustus 的學習筆記 — solving problems, in simple ways.

本篇大綱


本篇要解決的問題

在上一篇〈用 VuePress 製作說明文件頁面 — 3:導覽列〉我們設定好了頂部導覽列、側邊導覽列,進行到第三篇,用 VuePress 架的說明文件頁面已經很完整,可以把連結丟給同事們接受他們崇拜的眼光了。

但,Augustus 當初就是製作了二篇說明頁後,傳給同事看,同事竟然回了一句:「點開後 認真覺得眼熟 原來跟vue官方 的模組一模一樣XD」……總之,如果要跟官方的看起來不太一樣,就必需要自行安裝好其它佈景主題,不然一眼看過去就會是 Vue 的說明文件複製貼上改個字,想嚇人就只能嚇些沒看過 Vue 文件的人。


安裝佈景主題

官方文件中有提供可安裝的主題列表:Awesome VuePress Themes

這邊 Augustus 選擇一套深色主題:vuepress-theme-default-prefers-color-scheme 來安裝。

各個主題的頁面都有說明怎麼安裝,怎麼使用。

比方這套深色佈景,用終端機進到資料夾後,輸入:

yarn add -D vuepress-theme-default-prefers-color-scheme

然後在 config.js 這個配置檔中加入以下:

theme: 'vuepress-theme-default-prefers-color-scheme'

「vuepress-theme-」這個可以省略不寫,所以也可以寫成以下:

theme: 'default-prefers-color-scheme'

這樣就套好佈景主題了,是不是很簡單?

主題的說明文件裡也會有一些對 Options 的說明,也有一些佈景主題是需要改寫 config.js 裡面其他配置的,這部份就請看各自的主題說明文件。


安裝外掛(插件)

Plugins 在簡中的文字是翻作「插件」,但因為 WordPress 用習慣了,這邊寫作「外掛」會比較好理解。

VuePress 有不少外掛可用,文件上也有提供可安裝外掛清單:Awesome VuePress Plugins

這邊來安裝頁面必備的 Google Analytics。

跟佈景主題一樣,外掛的說明文件上通常會寫怎麼安裝,google-analytics 這個外掛就有寫使用說明。

用終端機進到資料夾後,輸入:

yarn add -D @vuepress/plugin-google-analytics

然後一樣打開 config.js,加入以下:

plugins: [
  [
    '@vuepress/google-analytics',
    { 'ga': '這邊填 GA 追縱碼 ID,如 UA-00000000-0' }
  ]
]

也跟佈景主題的「vuepress-theme-」可以省略不寫一樣,外掛的「plugin-」也可以省略不寫。

這樣,就安裝完成了。

如果想再加別的外掛,像是我們再來安裝 back-to-top 這套,用終端機進到資料夾後,輸入:

yarn add -D @vuepress/plugin-back-to-top

config.js 的 plugins 再加一行 '@vuepress/back-to-top',最後會像這樣:

plugins: [
  [
    '@vuepress/google-analytics',
    { 'ga': '這邊填 GA 追縱碼 ID,如 UA-00000000-0' }
  ],
  '@vuepress/back-to-top'
]

這樣就安裝完成,頁面如果可以捲動,往下捲時就會看到右下角出現一個三角圖示,點擊了就會滑到頁面最頂部。

當然,這二個都是比較簡單的外掛,也有不少外掛是需要額外加工,像 pwa

不用擔心,因為外掛的說明文件上大部份都會寫上加工方式。


原始碼、Demo

本篇開始,原始碼跟 Demo 都會放在 GitHub 上,歡迎取用。

Demo 會隨著系列文更新,所以看到的程式碼會逐漸豐富。

取用之前可以先對本篇拍個手或分享~

原始碼:https://github.com/letswritetw/letswrite-vuepress-document

Demo:https://letswritetw.github.io/letswrite-vuepress-document/


用 VuePress 製作說明文件頁面系列

  1. 安裝

  2. config.js 基本設定

  3. 導覽列

  4. 佈景主題、外掛

  5. 改樣式、加元件

  6. 部署

More from this blog

圖片壓縮:用 Compressor.js 自動調整品質壓縮至指定大小

本篇要解決的問題 很多網站功能會需要處理使用者上傳的圖片,比方讓使用者上傳會員照片。 但隨著手機相機愈做愈好,拍出來的照片隨便都是幾 MB,直接上傳的話,耗時也佔空間。 雖然網路上搜尋有許多圖片壓縮工具,但大多只能設定固定的壓縮的品質,無法保證壓縮後的檔案大小符合需求。 本筆記文將使用 Compressor.js 套件,實作一個圖片壓縮功能,符合以下需求: 自動嘗試不同的壓縮品質,直到檔案小於指定大小(ex: 600KB)為止。 將圖片轉換為 WebP 格式。 長、寬限制最大尺寸。 這...

Oct 4, 20254 min read
圖片壓縮:用 Compressor.js 自動調整品質壓縮至指定大小

使用 pm2.web 建立免費 PM2 監控系統

本篇要解決的問題 PM2 是 Node.js 裡常用的 process manager,一般如果是透過網頁監控、重啟,大概會使用官方的 Keymetrics。 但,But!就是這個 But!免費版最多只能監控 4 個 Process,再多就要掏出魔法小卡了。 問了 ChatGPT 後,發現有一個開源的替代方案:pm2.web,可以自己架設,不管幾個 process 都完全免費。 以下筆記如何使用 Vercel + MongoDB Atlas 部署 pm2.web,免費監控我們的 PM2。 架構...

Sep 26, 20252 min read
使用 pm2.web 建立免費 PM2 監控系統

GitHub Copilot + Figma MCP Server 實戰:用 AI 快速切版教學

本篇要解決的問題 最近在研究 MCP,剛好在 Threads 上看到有人實測 Figma MCP,想試看看是否真的能透過 AI 進行切版。 實作了一下後,還真的可以,不過目前僅針對簡單設計稿進行測試,結果略有跑版現象,整體效果尚可接受。 但目前就有這成果覺得厲害,再給它一段時間,也許前端工程師可以省掉切版的時間,把心力放到別的地方。 前提是,客戶要很明確的知道自己要什麼 XD,不然靠 AI 微調,還不如人工直接改程式還比較快。 用到的資源 以下是要實作用 Figma MCP 來切版,需要的資源:...

Apr 12, 20252 min read
GitHub Copilot + Figma MCP Server 實戰:用 AI 快速切版教學

使用 Google Apps Script 串接 Google Analytics API,整合多站數據

本篇要解決的問題 一間公司裡可能旗下會有多個網站,想同時查看所有網站的 GA 數據,通常需要開啟多個瀏覽器視窗並排顯示,操作較為繁瑣。 如果可以改由 API 來取得 GA 的數據,工程師就可以把各站的資料顯示在一個頁面上,而不用同時開多個 GA 來看。 開通 GA API 取得 GCP 專案編號 要先有 Google Cloud Platform(GCP)的專案,沒有的話登入自己的 Google 帳號,就可以先增一個。 專案編號就在 資訊主頁 上: 開通 GA API 功能 在使用 API ...

Mar 29, 20254 min read
使用 Google Apps Script 串接 Google Analytics API,整合多站數據

監聽 localStorage 事件:如何在同一頁面內偵測變更

本篇要解決的問題 我們有時會把資訊存在瀏覽器的空間裡,像是 Cookies、Local Storage、IndexedDB。 Local Storage 原生的 storage 事件主要用於跨分頁同步,如下: window.addEventListener("storage", () => {}); 但如果想要在同一個頁面內監聽變更,就需要手動覆寫 localStorage 方法。 localStorage event listener 我們可以透過 Storage.prototype 覆寫...

Mar 3, 20251 min read
監聽 localStorage 事件:如何在同一頁面內偵測變更
L

Let's Write

63 posts

前端工程師 August 的學習筆記 — solving problems, in simple ways.