RVL-Notes

RVL-Notes 是一個筆記知識庫網站，使用 GitHub Pages 發佈。內容以 Markdown 為主，並提供例如標籤與分類篩選、站內搜尋、目錄導覽與段落分享連結。

Features

• GitHub Pages 靜態部署
• Markdown 渲染，支援 GFM
• Obsidian 風格內部連結 [[slug]]

Getting Started

Prerequisites

• Bun

安裝 Bun 的方式請參考官方文件: https://bun.sh

Clone

git clone https://github.com/chiwei085/RVL-Notes.git
cd RVL-Notes

Install dependencies

bun install

Run dev server

bun run dev

啟動後在瀏覽器開啟終端機輸出的網址。

Build

bun run build

build 之前會自動執行 gen-updated，用 git 記錄生成 updated 時間。

Writing Notes

筆記放在 content/ 下，使用 Markdown 檔案。slug 由檔名決定。

content/
  guide/
  note/
  project/
  research/
  subpage/

內部連結語法

• [[rustdesk]] 會連到 /#/note/rustdesk

段落分享連結

• 文章內標題 hover 會出現 🔗，可複製 /#/note/<slug>?section=<headingId>

Markdown Syntax Support

KaTeX

Inline: $E=mc^2$

$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$

Callout

支援 note/info、tip/success、warning、danger/error。

> [!note]
> 這是 note（無標題）

> [!tip] Quick Tip
> 這是 tip（有標題）

> [!warning]
> 請先確認設定

> [!danger] 注意
> 這是高風險操作

Highlight

==highlight==

KBD

語法 {{kbd:Ctrl+Shift+P}} 會渲染成多顆按鍵 + 分隔符。

Press {{kbd:Ctrl+Shift+P}}
Press {{kbd:Ctrl + Shift + P}}

Badge

{{badge:WIP}} {{badge:ROS2}}

Fold

:::fold[更多細節]
這裡可以放一般 markdown（清單、程式碼、連結等）
:::

Embed

支援 YouTube / BiliBili：

![[youtube:J7Xzgcu6vVk width=720 aspect=16:9]]
![[bilibili:BV1MAZqBFEf3 width=640 aspect=16:9]]
![[bilibili:av123]]

• width: 寬度（px）
• aspect: 16:9 | 4:3 | 1:1（也支援容錯寫法 16/4/1）

Demo:

Scripts

• bun run dev 開發模式
• bun run build 建置
• bun run lint 靜態檢查
• bun run gen-updated 生成 updated 對照表
• bun run new-note <type> <slug> 建立新筆記模板

Contributing

歡迎提交 PR。

Workflow

• fork repo
• 建立分支
• 修改內容
• 確認能跑起來
• 提交 PR

建議在提交前跑一次

bun run lint
bun run build

Notes contribution rules

• 新增筆記放在 content/<type>/ 下
• slug 使用小寫與 - 或 _
• slug 需全站唯一
• 避免手寫 updated
• 若是延伸頁，使用 status: subpage，並放在 content/subpage/

License

MIT. See LICENSE.