安裝佈景主題

本文將說明如何安裝 Neso 佈景主題。
2025 年 10 月 11 日 多語版本:

準備 Hugo

瀏覽到這個網頁的你,應該有很高的機率已經安裝好 Hugo、甚至網站已在運行中,如果是這樣的話,請直接跳到下方的:安裝佈景主題

如果你還沒用過 Hugo,以下簡略說明如何準備好你的第一個 Hugo 網站:

安裝 Hugo

依照官網說明頁面,安裝 Hugo。

安裝前先讀我

  1. 安裝 Hugo 本體前,必須先依照說明頁面裡的「Prerequisites」章節,安裝好「Git」和「Go」。
  2. Hugo 有三個版本 (不是指作業系統):standard、extended、extended/deploy 版,請安裝「extended」版,其中:
  3. Hugo 提供多種安裝方式,若你使用 macOS,建議透過 Homebrew 安裝 (作者對 Windows 不熟,需要你自行查找資料)。
  4. Neso 佈景主題需要 Hugo v0.150.0 或以上的版本。

依序安裝好 GitGoHugo (extended) 後,最後在終端機確認:

$
hugo version

終端機回應 Hugo 版本資訊的話,即代表運行無誤。

建立 Hugo 網站

在終端機內依序執行下列指令。

移動 (cd) 到你的工作目錄後,執行:

$
hugo new site mysite

上面指令將建立一名為 mysite 的資料夾 (你可自行取名,之後將稱之為「Hugo 專案目錄」),並為你在裡面備好網站基本的原始碼檔案。

然後 cd 進入該專案目錄:

$
cd mysite

接著執行這個指令,將專案目錄初始化為 Git Repository (repo):

$
git init

建議你在此時準備好 .gitignore 檔案,並放進專案目錄頂層,如果你不確定 .gitignore 檔裡面要寫什麼,以下內容適合 Hugo 專案,供你參考:

# Hugo
/public/
/resources/_gen/
/assets/jsconfig.json
hugo_stats.json
/.hugo_build.lock

hugo.exe
hugo.darwin
hugo.linux

# Node modules
node_modules/

不習慣用終端機操作 Git?

  1. 如果你尚未適應終端機,最直觀的方式就是安裝 GitHug Desktop,然後將已 git init 的工作目錄加進 GitHub Desktop,接下來便可透過圖形化介面進行 Git 操作。
  2. 在 GitHub Desktop 內,從視窗左上角的「Current Repository」確認你正開著專案目錄的 repo,接著從上方工具列選擇「Repository」>「Repository Settings…」,彈出的對話框左側即可選擇編輯 .gitignore 檔,此時再將上面提供的文字貼進去即可。
  3. Git 方面使用 GitHub Desktop 沒有問題,但將來還是會有其他 Hugo 相關的操作無法避開終端機。

此時 Hugo 專案目錄已準備好,可開始安裝佈景主題。


安裝佈景主題

安裝 Hugo 佈景主題有多種方式,但由於佈景主題需要 Tailwind CSS,所以請先依照下列步驟,使用 npm 安裝 Tailwind。

補充

以下操作手續來自 Hugo 官方文件,可放心使用,若有更動以官網資訊為準。

  1. 在終端機內,cd 進入 Hugo 專案目錄,並執行:

    $
    
    npm install --save-dev tailwindcss @tailwindcss/cli

    此指令將在你的專案目錄內安裝 Tailwind 套件。

  2. 進入 Hugo 專案目錄,打開裡面的 hugo.toml 檔,並在檔案內添加以下內容:

    [build]
      [build.buildStats]
        enable = true
      [[build.cachebusters]]
        source = 'assets/notwatching/hugo_stats\.json'
        target = 'css'
      [[build.cachebusters]]
        source = '(postcss|tailwind)\.config\.js'
        target = 'css'
    [module]
      [[module.mounts]]
        source = 'assets'
        target = 'assets'
      [[module.mounts]]
        disableWatch = true
        source = 'hugo_stats.json'
        target = 'assets/notwatching/hugo_stats.json'

    這樣做的目的是告訴 Hugo 如何和 Tailwind 合作。

此時 Tailwind 已設定完成,接著要安裝 Neso 佈景主題本身,以下列出其中兩種方法:Hugo Modules、或手動安裝

透過 Hugo Modules 安裝 (推薦)

重要

Neso 佈景主題需要 Hugo v0.150.0 或以上的版本。

以此方式安裝佈景主題的好處是更新方便、且能保持專案目錄乾淨,因為 Hugo 會直接從 Neso 的 GitHub 拉取佈景主題的原始檔,你不需要自行管理。

  1. 在終端機內,cd 進入 Hugo 專案目錄,執行下列指令,來將你的專案初始化為 Hugo module:

    $
    
    hugo mod init github.com/<你的 GitHub 使用者名稱>/<你的 repo 名稱>

    舉例來說,假設你的 Hugo 專案將來上傳到 GitHub 的 repo 名稱是 mysite、而你的 GitHub 使用者名稱是 ghuser-blah,那麼你就可以這樣下指令:

    $
    
    hugo mod init github.com/ghuser-blah/mysite

    此操作無害,僅僅是一個準備動作,如果你不想輸入上述資訊,也可以隨意取名 (英數不要有空白):

    $
    
    hugo mod init mysite
  2. 接著編輯專案目錄裡面的 hugo.toml 檔:

    在稍早 Tailwind 設定的 [module] 表頭下新增 [[module.imports]],並照著輸入下列範例的 path = "..." 參數。

      # 其他設定...
      [[build.cachebusters]]
        source = '(postcss|tailwind)\.config\.js'
        target = 'css'
    [module]
      [[module.imports]]
        path = "github.com/babeneso/hugo-neso" # 必須是這個網址
      [[module.mounts]]
        source = 'assets'
        # 其他設定...
  3. 在專案內執行以下指令,拉取 Github 上的佈景主題的最新版原始檔:

    $
    
    hugo mod get -u github.com/babeneso/hugo-neso

    (日後要更新也是使用這個指令)

    如果你想鎖定在 / 更新到特定版本 (範例為鎖定 v0.1.3):

    $
    
    hugo mod get github.com/babeneso/hugo-neso@v0.1.3
  4. 建議再順手執行這個指令,清理不必要的資訊:

    $
    
    hugo mod tidy
  5. 最後執行以下指令,讓 Hugo 啟動本地伺服器 (用來預覽你的網站):

    $
    
    hugo server

    沒有問題的話,Hugo 應該會吐給你一個 http://localhost:xxxx/ 網址,如果你還沒有發表任何內容,連上去會看到空的頁面,這樣就代表完成了。

手動安裝

重要

Neso 佈景主題需要 Hugo v0.150.0 或以上的版本。

  1. 此處下載佈景主題的原始檔 ZIP 壓縮包,並解壓縮。

    將含有佈景主題原始檔的資料夾命名為 hugo-neso,放到你專案目錄的 themes/ 裡:

    mysite/   <- 你的 Hugo 專案目錄
    ├── ...
    ├── themes/
    │   └── hugo-neso/  <- Neso 佈景主題
    │       ├── assets/
    │       ├── i18n/
    │       ├── layouts/
    │       ├── hugo.toml
    │       └── ...
    └── ...
  2. 編輯你稍早設定 Tailwind 的那個 hugo.toml 檔 (☝️不是 hugo-neso/ 裡面那個喔!),在裡面添加 theme = "hugo-neso"

    baseURL = 'https://example.org/'
    languageCode = 'en-us'
    title = 'My New Hugo Site'
    # 以上是 Hugo 為你產生的東西
    
    # 加在這裡比較安全,放下面容易報錯
    theme = "hugo-neso"
    
    # 以下是稍早的 Tailwind 設定
    [build]
      [build.buildStats]
        enable = true
      [[build.cachebusters]]
        source = 'assets/notwatching/hugo_stats\.json'
        target = 'css'
        # 其他設定...
  3. 最後執行以下指令,讓 Hugo 啟動本地伺服器 (用來預覽你的網站):

    $
    
    hugo server

    沒有問題的話,Hugo 應該會吐給你一個 http://localhost:xxxx/ 網址,如果你還沒有發表任何內容,連上去會看到空的頁面,這樣就代表完成了。