文章

Jekyll Compose 擴充功能使用

Jekyll Compose

在運用 jekyll 撰寫部落格的時候我們會需要在文章 md 檔的開頭手動註明 Front Matter
例如這篇文章就需要列出:

1
2
3
4
5
6
7
---
layout: post
title: Jekyll Compose 擴充功能介紹
date: 2023-10-25 14:25 +0800
categories: [Blog]
tags: [jekyll] 
---

而且必須將文章檔名設定為 YYYY-MM-DD-TITLE.EXTENSION 的格式
例如這篇文章的檔案名稱就是:
2023-10-25-jekyll-compose-tutorial.md

說實在每次寫文章都要重新打一次有點麻煩
這時候我們就可以使用 Jekyll Compose 這個擴充功能來使用像 Hexo 一樣的自動產生模板

使用方式

首先我們要先在部落格資料夾中的 Gemfile 中加上這條:

1
gem 'jekyll-compose', group: [:jekyll_plugins]

然候在 terminal 中執行

1
$ bundle

完成後如果我們執行 bundle exec jekyll help 就能看到多出了幾個選項可以使用

1
2
3
4
5
  draft      # 創建一篇草稿
  post       # 創建一篇文章
  publish    # 將草稿文章移動到 _post 資料夾並發表出去
  unpublish  # 將已發表文章移動回草稿
  page       # 創建一個頁面,例如關於我

如果要新增一篇文章可以使用以下指令

1
$ bundle exec jekyll post "My New Post"

之後在 _posts 資料夾中就會得到一個叫做 2023-10-25-my-new-post.md 的檔案
並且會自動帶入預設的 Front Matter:

1
2
3
4
5
---
layout: post
title: My New Post
date: 2023-10-25 15:26 +0800
---

自訂選項

基本上這樣子就完成了 jekyll compose 的設定和使用
但如果覺得預設的 Front Matter 太精簡的話也可以自訂成喜歡的樣子
首先我們需要在 _config.yml 檔案中新增以下內容:

1
2
jekyll_compose:
  default_front_matter:

然後再依需要的功能新增設定進去,例如:

1
2
3
4
5
6
jekyll_compose:
  default_front_matter:
    posts:
      description:
      categories: []
      tags: []

這樣就能在每一次新增 post 時自動帶入 description、categories 和 tags 這三項設定
其中 description 可以為文章新增簡介
categories 可以填入文章分類
tags 則可加入文章標籤
更多能增加到 Front Matter 中的變數可以參考 Hugo 這篇文章

本文章以 CC BY 4.0 授權

Comments powered by Disqus.