小白也能用hugo架設自己的網站-3 專按設定檔案的常用參數設定

小白也能用hugo架設自己的網站-3 專案設定檔案中的常用參數設定

前言

這篇會讓大家知道普通的hugo主題模板該如何設定,以及我推薦的meme模板的設定,
如果想有更多的自訂空間,我還是建議使用meme主題模板,
meme的專案設定檔案其實很好懂,幾乎所有的功能都會在旁邊有註釋,
開始前,我來簡單介紹一下你可能會看到的東西代表什麼意思→

修改專案設定檔會用到的小知識

  1. 當你看到#這個符號時,代表#後面的文字是不會被執行的,直到行首沒有#時,才會執行該行的程式,
    所以當你有不想用的功能,例如網頁中的選單,就可以把選單的那幾行開頭加上#,使其不被執行,
    例如這樣
    #我是小羔羊,我師父是特種兵
    那麼這行就會被跳過,不會被執行,
    要注意的是,修改專案設定檔時,只要不是主題所允許的參數,每行前面都要有#來讓程式跳過這行,不然會導致執行發生錯誤喔!
    所以專案設定檔案裡常會看到用#開頭,後面是文字說明的內容
  2. theme = ""
    上面這個指示格式的範例喔,
    首先,theme是主題模板的參數名稱,中間會用一個等號隔開,等號前後要有空格,最後用雙引號包夾的是參數的設定值,
    通常在修改時,我們只需要改變雙引號裡面的文字,其它的不用動,
    例如像這樣→
    theme = "hugo-theme-meme"
    可以發現等號後面用雙引號包夾了hugo-theme-meme這段文字,
    上文說過,`theme是主題模板的參數名,也就是
    主題模板 = "我要的主題資料夾名"
    上面指令的意思就是,我要指定使用hugo-theme-meme這個主題,作為我網站的主題模板。
    另外,上一篇文章介紹的tokiwa網站主題模板就只要設定專案設定檔案的主題參數就可以使用了,
    可以直接跳過這篇關於meme的專案設定檔的相關內容
  3. true(真)和false(假)
    簡單來說專案設定檔中的true,你可以理解為開啟,
    而false,你可以理解為關閉,
    在專案設定檔中的很多地方,都會用這個參數來控制功能的開啟或關閉

  4. 沒錯,你看到的是空格,再專案設定檔裡,常看到很多行的最前面都會有很多空格,
    這些空格是縮排的意思,可能三言兩語沒辦法說得很明白,
    你只要記得,這些空格通常都是4個一組,
    完全沒有空格的是類似標題的參數,
    空四格的是在沒空格下的參數,
    空8格的是在空四格之下的參數,
    也就是說,整體是類似階層的概念,所以要特別注意不要誤刪,不然會打亂它們的分層關係,
    至於如果要加#來跳過某些行,有沒有在這些空格的最前面好像不是沒那麼講究,
    只要把#加在該行的文字之前就ok了。

開始設定專案設定檔案

打開專案設定檔案

以下我會整理出比較重要的幾個設定,但meme的設定參數非常豐富,除了我提到的這些,其它功能就需要自行探索了,
下面先講一些比較好修改的參數,還有網頁的選單、頁尾等,會在之後專門說明。

  1. 首先,找到專案資料夾enter進入,然後找到最下面的這個檔案:
    config.toml
  2. 按enter,系統會詢問要用什麼軟體開啟,tab一次,
    往下找更多應用程式按空格,再往下找記事本enter,
    如果有安裝notepad++,也可以用它來開啟專案設定檔案,
  3. 接下來的操作就跟改普通的記事本一樣,你只要記得前面說過的重點,相信修改參數難不倒你!

專案設定檔案的常用參數

接下來,你可以複製下方的參數名稱,也就是等號前面的名稱,利用記事本或notepad++的搜尋功能,就能很快找到,
搜尋的快速鍵是ctrl+f,貼上文字後enter就會跳到有對應文字的那一行,接著按ESC關閉搜尋框,就能上下左右看到文字了,
修改時,建議不要拿下面的參數直接複製貼上,避免產生縮排不對的問題,
只要複製雙引號內的文字,替換掉自己專案設定檔中相應參數的雙引號內即可,
另外要注意true和false不需要雙引號包夾。

  1. 網站最終的網址
    baseURL = "https://example.com/"
    上方雙引號內的網址為模板預設,並不是真正的網址,關於要用github還是自己租linux主機來架設網站,我會在之後文章介紹
  2. 給網站取的名字
    title = "hugo-theme-meme"
    將雙引號內的文字改為你想給網站取的名字,這個名字也就是打開網站後的視窗標題
  3. 指定要使用的主題
    theme = "hugo-theme-meme"
    雙引號內填入主題資料夾的名稱,也就是位於
    專案資料夾內的themes資料夾內的主題資料夾
    將資料夾名複製後填入即可,上面的範例適用meme的主題
  4. 是否顯示返回頂部按鈕
    enableBackToTop = false
    預設是true,因為容易產生亂碼,所以將其關閉,也就是改為false
  5. 分節標題錨點
    enableHeadingsAnchor = false
    預設是true,因為容易產生亂碼,所以將其關閉,也就是改為false
  6. 是否連結文章的分節標題到目錄
    linkHeadingsToTOC = false
    預設是true,這個功能是將文章中的每個標題也轉換成連結,可以點連結回到文章頂部對應的目錄連結,
    個人覺得這個功能,如果我們用tab操作找文章連結時會有點干擾,而且也會亂碼,所以我是將其關閉
  7. 作者的名字
    name = "小羔羊"
    雙引號內替換為你想讓作者看到的作者名
  8. 電子郵件
    email = "1234@gmail.com"
    雙引號內替換為你的電子郵件,讓讀者可以找到你
  9. 座右銘
    motto = "小羔羊是台灣最愛分享的羊"
    雙引號內替換你想給讀者看到的座右銘
  10. 你的網站
    website = "http://lamb.tw"
    雙引號內可以填入你想讓讀者看到的網站,在之後成功架設網站在填入網址也ok
  11. 站點的描述
    siteDescription = "這個網站存放小羔羊的教學文章和音樂"
  12. 站點的建立時間
    siteCreatedTime = "2021-08-22T20:17:43+00:00"
    注意:請保持此格式,更改數字就好
  13. 文章是否為原創
    original = true
    會影響文章的作者資訊和版權資訊
  14. 是否顯示釋出時間
    displayPublishedDate = false
    我們之後用指令建立新文章的模板時,檔案裡會自動填入建檔的日期,
    這個功能則是顯示文章發布的日期,
    當這裡為true,文章中就會看到兩個日期,一個是文章內建檔的日期,另一個是發布的日期,
    所以推薦將此功能關閉,顯示建檔日期即可
  15. 是否顯示過期時間
    displayExpiredDate = false
    我用不到的功能,因此關閉
  16. 是否顯示修改時間
    displayModifiedDate = false
    我覺得不需要,因此將其關閉
  17. 是否顯示字數統計
    displayWordCount = true
    我也覺得用不到,因此也關閉
  18. 版權資訊(支援 Markdown)
    copyright = ""
    這個很重要,如果保持預設不修改的話,引號裡面會有一條網址,在首頁上會多出一條沒用的連結,
    你可以在裡面輸入版權宣告,例如:請勿擅自轉載違者必糾,之類的文字
  19. 文章中是否顯示分類
    displayCategory = false
    如果你在寫新文章時,有將文章分類,這裡就能選擇是否在文章頁面中顯示該文章的分類
  20. 文章的段首縮排
    enableParagraphIndent = false
    可能會影響排版,所以我個人是將其關閉
  21. 兩端對齊
    enableJustify = false
    會影響文章的排版,所以我會將其關閉
  22. 是否在文章中顯示文章版權
    enablePostCopyright = true
  23. 文章頁面是否顯示分享按紐
    enablePostShare = false
    個人感覺佔蠻多版面的,所以我就直接關閉了,
    一般分享可以直接複製網址,所以不是特別需要
  24. 文章頁面中是否顯示文章上下篇
    enablePostNav = true
    文章中會有上一篇和下一篇的文章連結,方便讀者瀏覽,
    上下篇的排列順序會以文章的時間來排列,如果相同時間,那就可以透過文章標題中連續的數字來排列
  25. 是否顯示1. 頁尾
    enableFooter = true
    頁尾可以放訂閱rss、聯繫mail等等的連結,這個選項關閉的話就會完全隱藏這些部分,所以建議開啟
  26. 文章頁面中是否顯示版權符號(©)
    displayCopyrightSymbol = true
  27. 是否顯示站點的建立年份
    displaySiteCreatedYear = true
  28. 是否顯示Hugo和MemE的連結
    displayPoweredBy = false
    推薦關閉,不然首頁會有hugo主題的相關資訊和連結
  29. 是否顯示站點的版權資訊
    displaySiteCopyright = true
    打開後可以顯示版權訊息,顯示的內容就是之前那些參數裡填寫的內容

下篇待續