iT邦幫忙

2022 iThome 鐵人賽

DAY 10
0
自我挑戰組

Blog 掛掉時在做什麼?有沒有空?可以來重建嗎?系列 第 10

在一則筆記頁面中該顯示哪些資訊?

  • 分享至 

  • xImage
  •  

今天來想想一個筆記頁面預計會顯示哪些資訊,又需要哪些資料吧。

最基本的莫過於下列幾個選項:

  • 標題
  • 內文
  • 建立時間
  • 更新時間

到這邊有一個構想,如我在 Day 7 聊到的,我將我的 Markdown 檔案透過 Git 管理。那如果我的檔案裡面並沒有建立時間與更新時間時,我是不是可以透過 git-log 去協助取得?

這邊又延伸到當時的構想:

可以透過 log 瞭解我筆記的編修紀錄、透過 blame 瞭解我最近做了什麼更動,甚至可以透過 MR 提出修改或交流!

那我或許也能在生成頁面時,就讓系統透過 git 取得與這個檔案有關的 log,然後將它渲染在筆記內文下方。然後再利用紀錄在設定檔的 Github Repository 網址,建立與那個 commit 有關的連結。可能會像是這樣:

<Title>

<Content>
<Content>
<Content>

---
Update Log:
- 2022-09-05: 補充有關某某某的論述。 [hash]
- 2022-09-03: 修正這篇筆記的某某錯誤。 [hash]
- 2022-09-01: 建立此篇筆記。 [hash]

只要點擊 [hash] 就可以連到 Github 上。

另外可以放的資訊可能與雙向連結有關,像是

  1. 參考此篇筆記的頁面清單
  2. 這個筆記深度 n 以內的視覺化圖形

我在想,如果是文章頁面參考到這篇筆記的話,會滿適合用第一種的,讀者就可以透過這篇筆記連到那些文章,透過文章就可以暸解一個被各個筆記組裝起來的知識系統,然後藉此去探索更多筆記。

而筆記之間的雙向連結,就比較適合使用第二種,且第二種應該排除與文章頁面的連結網路,藉此強調各個知識點的相互關係。

另外可能就是再加上 MOC 與 Tag 的清單。所以最後預期可能會是這樣:

<Title>
<Info Bar: Author, Create Date, Last Update Date>

<Content>

<MOC list>
<Tag list>

<Article page List which Reference current note>
<Bi-Directional Link Graph between note page>

<Update Log>

---

<Comment Feature (optinoal)>

上一篇
會有什麼後設資料想要設置?有什麼有趣的構想? (2)
下一篇
我該選擇哪套系統去實作第一版的 Blog?
系列文
Blog 掛掉時在做什麼?有沒有空?可以來重建嗎?30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言