HOME NOTES

筆記的排版格式(範本)

次瀏覽

每篇筆記都是 posts/ 目錄下的一個 Markdown 檔案,檔名就是網址。這篇示範所有支援的排版元素,新增文章時直接複製本檔改寫最快。

檔名與網址

檔名格式為 YYYYMMDD-英文短名.md,例如本檔為 20260905-writing-format.md,對應網址即 /20260905-writing-format

檔頭欄位

每個檔案開頭要有一段 front matter:

---
title: 文章標題
date: 2026-09-05
author: 林耿億醫師
summary: 首頁卡片上顯示的一兩句摘要。
---

date 是發布日;更新日不用自己寫,建置時會依 git 紀錄自動判定。

可用的排版元素

強調與行內標記

可以用粗體標出重點,用斜體表示術語或書名,用 行內程式碼 標示劑量單位、檢驗代號這類需要精確呈現的字串。

清單

無序清單適合平行的項目:

  • 第一項
  • 第二項
  • 第三項

有序清單適合有先後的步驟:

  1. 先做這個
  2. 再做那個
  3. 最後確認

表格

表格在手機上會自動變成可左右滑動,不會擠壓變形:

項目說明備註
欄位一這是第一欄的說明文字可留空
欄位二這是第二欄的說明文字
欄位三較長的內容也不會破格,會自動換行處理見下方

引用

引用區塊適合放指引原文、定義,或是需要與正文區隔的提醒。

可以有多個段落。

程式碼區塊

超出寬度時會自己出現橫向捲軸,不會把版面撐破:

npm run build        # 重新產生 public/ 底下的靜態檔案
git add -A && git commit -m "新增筆記"
git push             # 推上去後 Cloudflare Pages 會自動部署

連結

站內連結這樣寫:回到開站說明。站外連結會自動在新分頁開啟,例如 Wikimedia Commons

分隔線

三個減號可以畫一條分隔線:


新增一篇筆記的完整流程

  1. posts/ 建立新的 .md 檔,檔名用 YYYYMMDD-短名.md
  2. 填好 front matter 的 titledatesummary
  3. 寫內容
  4. 執行 npm run build,確認終端機列出的文章清單正確
  5. git add -A && git commit && git push

推上去之後,Cloudflare Pages 會自動重新建置並上線,首頁卡片會多一張,排序自動把最新的放前面。

回到全部筆記