貢獻指南
幫我們把文件寫得更好,新增或修改頁面的方法都在這。
文件都在 GitHub 上的 yeecord/website,每頁右邊都有「編輯此頁」可以直接改。
新增頁面
在 content/docs/ 建立 MDX 檔案,開頭一定要有 frontmatter:
---
title: 你的標題
description: 這一頁在講什麼?
---
內文...新頁面要加進同資料夾的 meta.json 才會出現在側欄:
{
"pages": ["index", "my-page"]
}部落格文章放在 content/blog/,多了 authors、date、tags 欄位,作者資訊定義在 config.ts 的 blogAuthors。
寫作原則
- 用表格和標題,不要一大坨文字
- 假設讀者可能沒用過 Discord,術語第一次出現時連到 新手入門
- 展示指令用
<SlashCommand />、模擬機器人回覆用<DiscordChat />,不用截圖 - 中英文和數字之間留空格,照 中文文案排版指北
- 不要自我宣傳、不帶政治立場
MDX 的其他功能可以參考 fumadocs 的文件。
有問題?
到 支援伺服器 找我們聊。