👋 歡迎

歡迎訪問 在溪維基 —— 由 yunzaixi-dev 個人維護的在線文檔站.

關於文檔分區

本站採用"單一歸屬 + 優先級判定"，避免重複與交叉：

• 單一歸屬：每篇文檔只放在一個主類；次要主題用正文鏈接引用，不要複製到多個目錄。
• 判定順序（從高到低）：
  1. 含隱私/密鑰/未公開信息 → 私有專區
  2. 課程/學術/考試相關 → 大學專區
  3. 站點/倉庫元信息、歷史沿革、維護規範 → 歷史專區
  4. 按"主要落地位置"歸類：瀏覽器/客戶端 → 前端；服務器/業務/API → 後端；CI/CD/交付流程 → 運維；計算/存儲/網絡/數據庫/雲/監控平台 → 基礎設施
  5. 與具體技術實現弱相關的效率/流程/習慣 → 工作流專區
  6. 其餘可公開分享的通用內容 → 公共專區
• 邊界規則：運行位置優先於使用語言；部署/平台建設歸基礎設施，交付流水線歸運維；隱私與學業判斷優先於技術域。
• 存放要求：文件必須位於對應目錄，必要時同步更新 frontmatter / 側邊欄。

歷史專區

• 範圍: 記錄本站的歷史,技術實現,開發日誌,站主相關信息等.
• 排除: 具體技術內容或學習筆記(按技術域歸類), 私密或未公開資料(轉私有), 學術課程內容(轉大學).

前端專區

• 範圍: UI/交互、瀏覽器或跨端框架(Svelte/SvelteKit)、前端工程化(Vite/Webpack 前端配置)、CSS/設計系統、Web API 與組件庫.
• 排除: 服務端渲染的後端邏輯、API 設計、數據庫訪問、部署/發佈流程(轉後端/基礎設施/運維).

後端專區

• 範圍: 業務服務與 API 設計、BFF/GraphQL/REST、服務器端語言與框架、領域建模、數據訪問層實現、鑑權/會話等服務端能力.
• 排除: 數據庫/消息隊列的部署與運維(轉基礎設施), CI/CD 與發佈策略(轉運維).

運維專區

• 範圍: CI/CD 流水線、構建/發佈/灰度策略、環境差異管理、質量門禁、SRE 工具鏈、團隊規範.
• 排除: 基礎設施層面的集群/網絡/存儲建設(轉基礎設施), 業務功能編碼(轉前後端).

基礎設施專區

• 範圍: 計算/存儲/網絡/操作系統、容器與編排(Kubernetes)、數據庫與緩存、消息隊列、監控/日���/告警平台、雲服務配置.
• 排除: 只涉及交付流程的流水線腳本(轉運維), 業務層的數據訪問代碼(轉後端).

工作流專區

• 範圍: 個人/團隊效率工具與流程、自動化腳本、時間管理、筆記/知識管理方法、與具體技術實現解耦的工作習慣.
• 排除: 任何以技術實現為主的內容(轉對應技術分類), 學術課程(轉大學).

大學專區

• 範圍: 課程筆記、實驗報告、學術閱讀、考試複習、校內項目.
• 排除: 企業項目或生產環境相關內容(按技術域歸類), 含隱私的材料(轉私有).

公共專區

• 範圍: 無敏感信息且跨領域的通用知識、公開演講/閱讀摘錄、無需具體技術上下文也能理解的內容.

• 排除: 任何包含未公開信息或需要訪問控制的資料(轉私有), 技術實現細節(按技術域歸類).

• 範圍: 含個人隱私、密鑰、賬號、內部資料或尚未公開的規劃.

• 注意: 如主題同時符合其他分類, 仍以私有專區為最終歸屬.

文檔工具鏈

關於 LaTeX

LaTeX 是一個基於 TeX 的文檔排版軟件系統。LaTeX 提供了一種高級的、描述性的標記語言，使 TeX 的使用更加便捷：TeX 負責文檔佈局，而 LaTeX 則負責文檔內容的處理。由於 TeX 的格式化命令非常基礎，因此它為作者提供了現成的命令，用於滿足諸如章節標題、腳註、交叉引用和參考文獻等格式和佈局需求。

我們使用 Latex 來表達文檔站中的數學公式

關於 Markdown

Markdown 是一種輕量級標記語言，用於通過純文本編輯器創建帶格式的文本。John Gruber 於 2004 年創建了 Markdown，目的是打造一種易讀、易寫的標記語言。

Markdown 被廣泛應用於博客、即時通訊以及大型語言模型中，同時也常見於在線論壇、協作軟件、文檔頁面以及 README 文件中。

我們使用 Markdown 構建文檔站的內容

版本管理與 CICD

關於 Git

Git 是一個快速、可擴展的分佈式版本控制系統，擁有異常豐富的命令集，既提供高層次的操作，也允許完全訪問其內部機制。

我們使用 Git 進行文檔站的版本管理

關於 GitHub

GitHub 是一個專有的開發者平台，允許開發者創建、存儲、管理和共享代碼。它使用 Git 來實現分佈式版本控制，同時 GitHub 本身還為每個項目提供訪問控制、缺陷追蹤、軟件功能請求、任務管理、持續集成以及 Wiki 等功能。

GitHub 自 2018 年起成為 微軟的子公司，其總部位於舊金山。

文檔站的代碼託管在 GitHub 私有倉庫上

關於 GitHub Actions

GitHub Actions 是 GitHub 提供的一項工作流自動化平台，用於在代碼倉庫內自動化、自定義並執行軟件開發流程中的任務（常見用途包括持續集成與持續部署）。它允許開發者創建、發現與複用"actions"（可複用的自動化組件），並將多個 actions 組合為可配置的工作流，從而完成構建、測試、發佈、部署等工作。

GitHub Actions 採用事件驅動機制：工作流通常以 YAML 文件定義，能夠在特定事件發生時觸發運行（例如代碼推送、拉取請求、定時任務或手動觸發等）。工作流由一個或多個作業組成，作業在稱為"運行器"的執行環境中運行；運行器既可以是 GitHub 託管的環境，也可以由用戶自行託管。

GitHub 於 2018 年在 GitHub Universe 活動期間對外發佈 GitHub Actions，將其定位為面向倉庫內自動化與工作流編排的能力。

文檔站在 Github Action上執行構建,部署與自動翻譯

前端工具鏈

關於 V8

V8 是由 Google 開發的開源 JavaScript 與 WebAssembly 引擎，最初隨 Google Chrome 於 2008 年發佈。它通過即時編譯（JIT）等優化技術將 JavaScript 編譯為機器碼，以提升執行性能；目前被廣泛用於 Chrome、Node.js 及其他基於 Chromium 的項目中。

文檔站的運行環境是 V8

關於 Node.js

Node.js 是一個基於 V8 的跨平台 JavaScript 運行時環境，採用事件驅動與非阻塞 I/O 模型，常用於構建網絡服務與命令行工具。該項目最初由 Ryan Dahl 於 2009 年發佈，並圍繞 npm 形成了規模化的第三方包生態。

文檔站的構建與開發環境是 Node.js

關於 TypeScript

TypeScript 是由 Microsoft 主導開發的開源編程語言，是 JavaScript 的類型化超集，並會編譯為 JavaScript 運行。它引入靜態類型、接口與泛型等特性，以提升大型 JavaScript 項目的可維護性與工具支持（如類型檢查與自動補全）。

文檔站的開發語言是 TypeScript

關於 React

React 是由 Facebook（現 Meta）維護的開源前端 UI 庫，最初於 2013 年發佈。它以組件化與聲明式渲染為核心，通常結合單向數據流、Hooks 等機制來構建可複用的用戶界面。

文檔站的 UI 框架是 React

關於 Yarn

Yarn 是 JavaScript 的包管理器，由 Facebook 等團隊於 2016 年發佈，用於改進依賴安裝的速度與可複現性。它通過 lockfile（如 yarn.lock）鎖定依賴解析結果，並提供緩存與並行下載等機制。

文檔站的包管理器是 Yarn

關於 Vite

Vite 是面向現代前端開發的構建工具與開發服務器，由 Evan You 於 2020 年發佈。其開發模式基於原生 ESM 的按需加載，並在生產構建階段通常使用 Rollup 進行打包，以獲得更快的啟動與熱更新體驗。

文檔站的構建工具是 Vite

關於 Rspack

Rspack 是一個以性能為目標的前端打包工具，採用 Rust 實現核心，並強調對 Webpack 生態（配置、loader 與 plugin 接口等）的兼容性。它於 2023 年開源，常用於大型項目的構建加速與增量編譯場景。

文檔站的構建工具是 Rspack

關於 Docusaurus

Docusaurus 是由 Facebook（現 Meta）開源的靜態站點生成器，主要用於構建文檔站點，最初於 2017 年發佈。它以 Markdown/MDX 為主要內容格式，並提供側邊欄導航、版本管理、多語言、主題與部署等能力，適合將文檔作為工程產物進行維護與發佈。

文檔站的開發框架是 Docusaurus

開發守則

自動化勝於手工。
聲明式勝於命令式。
不可變勝於可變。
彈性勝於固定容量。
可觀測性至關重要。
失敗是常態，而非例外。
快速恢復勝於避免失敗。
去中心化勝於單點依賴。
標準勝於定制。
平台能力勝於個人技巧。
基礎設施應當像代碼一樣被管理。
環境應當一致，而非恰好能跑。
服務應當獨立，而非相互糾纏。
擴展應當是水平的，而非垂直的。
發佈應當頻繁且可回滾。
安全應當內建，而非事後補救。