這個網站是由 114 級電機社一手打造，為了避免網管再次成為失傳技藝， 本文檔會盡力對如何進行更新、改動文章內容，以至於貢獻程式碼進行紀錄與提供方向。

但這不會手把手教你如何對開源專案進行貢獻，如果有這需求，請洽 [教材] Open Source。

項目概覽

📁 cec —— 文章 / 教材儲存位置
📁 src —— 網站主要程式內容（詳細介紹在下方）
📁 static —— 網站靜態內容（如圖片）
📁 tests —— 網站端對端（End-to-End）測試
📁 tnfshcec.inlang —— 多語言工具 Inlang 設定檔
LICENSE
README.md
package.json
其他設定檔...

新增、更新文章

我們的文章都放在 cec/ 資料夾裡。 裡面你會看到很多 something.md 的文字檔，一個檔案就是一篇文章。 同時，這個檔案的路徑會直接對應他的網址路徑，例如：cec/docs/contribution-guide.md -> /post/docs/contribution-guide

至於詳細的介紹，請往下滑：

檔案結構

最簡單來說，這就是 Markdown。 但是加了 GFM、一些自訂的擴充功能，還有支援 Svelte 語法。（謝謝 mdsvex 和 remark！）

1. Frontmatter（文章資料）

   Frontmatter 是置於 Markdown 內容之前，用於描述檔案附加資料的方式。 Markdown 的 Frontmatter 是在檔案的最上方、上下用 --- 包圍的一個區塊，裡面使用 yaml 格式指定資料。 例如：

   md

   ---
   hello: world
   mom: 123kg
   ---
   
   **Markdown 內容**

   Note

   這邊就不為 yaml 多做介紹，他類似 json，是個資料表示方式，大致使用 key: value 的格式。 詳細的規則和格式，就請各位去 Google 一下了。

   而我們網站的文章都可以指定以下的幾個 key，會用於網站各處的顯示。 （以下也附上他們的資料型態，以 TS 的方式呈現。）

   ts

   interface PostData {
     title: string;     // 文章的標題。
     author: string;    // 文章的作者。
     desc: string;      // 文章的概述或簡介。
     date: string;      // 寫作的日期。
                        // 使用 ISO 8601 的日期格式會自動轉成用戶界面的語言。例如 2024-01-23。
   
     image: string;     // 文章相關的圖片，會顯示在文章頁面的背景。這邊請填圖片網址。
     lang: string;      // 文章的語言。目前我們網站有 `zh-tw`、`en`、`ja` 三種。輸入其他語言可能出現未定義的行為。
     tags: string[];    // 文章的標籤。如果 `lang` 有被指定，會自動加上那個語言的標籤。
     pinned: boolean;   // 文章是否釘選。預設 `false`。釘選的文章會在列表最上方顯示。
     unlisted: boolean; // 文章是否不公開顯示。預設 `false`。
                        // 不公開的文章需要直接使用網址查看，在列表不會出現，搜尋引擎也不會列出（應該）。
                        // 請注意不公開的文章仍然可以被任何有網址的人檢視，或是直接從 GitHub repo 被看到。
   }

   提示

   這邊看不懂就算了，看一下其他文章的 Frontmatter 是怎麼寫的，複製過來改一下就好了。 （那樣搞不好還比較快。）

2. 內文

   內文就是 Markdown 內容了。不清楚的往這邊走：[教材] 基礎Markdown使用教學

   除了基礎的 Markdown 語法，我們支援、增加了一些另外的語法：表格、暴雷內容、GFM Alert、 程式區塊的特殊功能（指定檔案名、指定 highlight、diff 註解）

   另外可以直接使用 Svelte 組件（Components），也可以使用 Svelte 的語法（像是 Svelte 的反應系統）。

   提示

   內文中可以使用的元素大致都列在 Elements，原始碼在這邊。

進行更改

講完了內容寫什麼，來講講到底要怎麼新增文章、或對現有內容修改。

首先，你可以直接用 GitHub 提供的編輯模式寫作。 因為我們都是 Markdown 文字檔而已，GitHub 的編輯器其實不會太糟，你也能預覽檔案渲染出來會長什麼樣（不過有一兩個我們特定的語法 GitHub 看不懂）。 在 GitHub 編輯完，應該就可以直接 commit、送 PR 了。就免去了其他麻煩。

或是，你可以把 repo 複製下來，使用你喜歡的編輯器編輯，並在我們這個實際的頁面做預覽。

git clone https://github.com/<username>/tnfshcec-web.git # Use tnfshcec as username if you are not making modifications
cd tnfshcec-web
npm run dev                                              # Start the dev server

做完更改，寫完 commit 之後，就可以上傳到你的 fork 裡面。

提醒各位，我們的 Markdown 檔案都放在 cec/ 資料夾裡，檔案路徑對應他的網址路徑。

提交更改

進行你的更改後，照平常的流程 commit 完後，就可以送 PR 提交這些更改了。 送完 PR，有人檢查 OK 之後，就可以合併進主分支，接著就會自動部署上這個網站了！

貢獻、改動網頁本身

目前本網站使用 Svelte、Tailwind、mdsvex、Inlang 等前端工具製成，並透過 GitHub Actions 和 Pages 進行佈署與架設。 這些工具對我們都至關重要，每個都是網站的核心部件。讓我們感謝 JavaScript 與網頁開發社群的活躍與創新，讓我們能如此簡單的建造出非常好的一個網站 🙏

這些工具可能你沒聽過、不會用、或不是很懂，這都沒關係。 你可以針對你理解的部份進行更新就好，或是它們都提供了很好的文檔與教育內容， 或許在讀過之後，你的知識庫又增加了一項實用的工具啦！

你需要的技能

1. 網頁前端技能
2. TypeScript
3. Svelte、SvelteKit
4. Tailwind

還有其他許多的組件庫、函式庫，如以下：

• Bits UI - 組件庫
• Inlang / ParaglideJS - 提供 i18n （多語言）
• mdsvex - 提供 Svelte 中的 Markdown 讀取
• Unplugin Icons - 提供圖標

就看你需要什麼了

原始碼大致架構

📁 cec —— 文章 / 教材儲存位置
📁 src —— 網站主要程式內容
┣ 📁 lib —— 一些在各頁面會用到的素材 (assets) / 組件 (components) / 函式
┣ 📁 messages —— 各語言的訊息翻譯
  ┗ (language).json
┣ 📁 routes —— ★ 網站的各個路徑。每個資料夾會對應到一個路徑。
  ┣ 📁 路徑...
  ┗ +page.svelte / +page.ts —— 這個路徑上的頁面
┣ app.d.ts —— 適用於整個 codebase 的 type 定義（TypeScript 特定的東西）
┣ app.html —— 每一個頁面的基底。一般不會在這裡做改動。
┣ app.postcss —— 適用於每個頁面的 CSS 規則。如果不是每個頁面都需要，請不要隨便更改。
┗ hooks.server.ts / hooks.ts —— Hook 系統，一般也不會碰到這邊。
📁 static —— 網站靜態內容（如圖片、robots.txt）
其他省略...

因為我們使用 SvelteKit 框架，你可能需要去好好了解 SvelteKit 的架構。

編輯頁面時，每一個頁面都是一個 Svelte 組件，所以看不懂的話，請移駕到 Svelte Learn 或查看 Svelte Docs 和 SvelteKit Docs。

進行更改、測試功能

注意這邊你也必須要自己 fork 或是新增分支，我們的主分支是不能直接進行更動的。

git clone https://github.com/<username>/tnfshcec-web.git # Use tnfshcec as username if you are not making modifications
cd tnfshcec-web
npm run dev                                              # Start the dev server

（其實編輯文章和程式碼是一樣的動作，只是我覺得把程式碼放在下面比較沒那麼嚇人而已。）

這邊就要看你想要新增或修改什麼了，這邊我沒辦法幫你太多， 大致上你要這樣做：

1. 找到你想要改的部份

   在 .svelte 檔案你可以找到頁面的 HTML 和各元素的 Tailwind 樣式、 在 .ts 檔案你可以找到一些功能上的邏輯。

2. 確定你在更改的程式碼是你的目標

   沒錯，在改之前總要知道他實際上在幹嘛

   我在開發時通常會以可讀性為最大目標（你也應該要）， 希望你在看了我的變數命名和 JSDoc 註解之後能看懂裡面的邏輯。

3. 做完你的修改，記得測試一下！寫出來的 code 常常想像和表現的不一樣，或是漏掉了什麼邊緣情況。

   做完之後，如果有什麼地方是比較難懂、難看的，也請你適時加上註解。 寫了新的 function 也可以用 JSDoc 進行紀錄。（詳細請參考現有程式碼的 JSDoc 文檔或註解！）

4. 用 Prettier 格式化檔案

   做完你的編輯麻煩用我們的格式化工具讓程式碼變成統一格式！ 我們整個 codebase 基本上都遵守格式化工具的規則，如此讓不同人寫的 code 也能有一致的格式。

   Note

   使用 Prettier 工具的方法

   Prettier 是我們目前使用的格式化工具，讓整個 repo 的程式碼統一風格。

   最簡單的方法，是安裝 Prettier 的 VSCode 插件， 之後右鍵選單就看得到格式化（Format）的選項了。 你也可以打開自動格式化的設定，讓你每次儲存檔案，程式碼就會變成該有的樣子。

   如果你不用 VSCode 想打指令的，可以用 npx prettier --write <檔案或資料夾>

如果有問題，還請你直接找身邊的人 / 學長 / 維護或開發網頁的 114 級幫忙， 如果我們知道怎麼做，我們都是很樂意幫忙的，除非他是學測或分科戰士（請幫他們加油謝謝 🥲）。

提交更改

提交更改就是一樣的步驟了，儲存檔案、寫好 commit、推（push）上雲端，然後提交你的 PR。 接著管理員就會來幫你審核了。

結語

接下來，就歡迎各位來作貢獻啦！

尤其是電機社社員、幹部，我在製作開發這個網站時也是透過做這些動作，一點點、一點點學習起來的。 希望你們也能在做的的過程中，學到一點東西。

現在，為了讓電機社繼續飛揚，我想這裡的各位必須跟上、甚至超越我們，參與、學習，並且一起進步！