README
此網站以 Docusaurus 建立,是一個現代化的靜態網站生成器。
📂 目錄結構
/adr:架構決策紀錄與 RFC 提案 (以 Blog 形式呈現)。/blog:存放技術調查
🛠 環境建置
本專案使用 pnpm 作為套件管理器,請依照以下步驟完成環境設定:
-
安裝 Node.js: 前往 Node.js 官網 下載並安裝 LTS (Long Term Support) 版本。
-
啟用 Corepack:
Node.js 預設內建了 Corepack,請開啟終端機執行以下指令來啟用 pnpm:
corepack enable pnpm
pnpm setup
- 安裝依賴:
pnpm install
- 啟動本地開發伺服器:
pnpm start
瀏覽器將自動開啟並導向 http://localhost:3000。
✍️ 撰寫指南
1. 基礎語法
本平台完整支援 GitHub Flavored Markdown (GFM),也就是通用的 Markdown 語法。詳情可參考 GFM Spec 指南。
除此之外,若你想要使用 React 語法撰寫頁面也可以,有許多特色語法,請參考 MDX Feature。
2. 提示框 (Admonitions)
用於強調特定資訊,支援 note, tip, info, warning, danger。
:::tip[專業建議]
在撰寫 RFC 時,建議優先描述「問題」而非「解決方案」。
:::
專業建議
在撰寫 RFC 時,建議優先描述「問題」而非「解決方案」。
詳細請參考Admonitions
3. Mermaid 圖表
支援直接在 Markdown 中繪製流程圖、時序圖與甘特圖:
4. 數學算式
支援 KaTeX ,用於在 Web 上渲染 TeX 數學公式。
$$
I = \int_0^{2\pi} \sin(x)\,dx
$$
🏛 決策紀錄流程 (ADR/RFC)
當你需要提出新的技術選型或架構異動時,請遵循以下狀態流程:
- Proposed (提案中):初期的 RFC(Request For Comments) 構想,開放大家閱覽。
- Accepted (已通過):經過團隊共識,正式採用的技術方案。
- Superseded (已取代):隨著系統演進,該決策已被新的 ADR 取代。
- Rejected (已拒絕):評估後不採行的方案,保留紀錄以供日後參考。