工程開發
mintlify avatar

mintlify

維護 Mintlify 文件網站:設定導覽列、管理 MDX 內容、新增元件以及處理 API 參考文件。

簡介

Mintlify 技能使代理程式能夠使用 Mintlify 平台建立、組織並維護高品質的文件網站。它專為開發人員、技術撰稿人及產品團隊設計,旨在將 MDX 內容轉換為專業且易於搜尋的文件站點。此技能涵蓋了從初步配置到內容組織及部署準備的全生命週期。

  • 網站配置:透過 docs.json 結構管理全域設定,包含主題自訂、品牌標識、顏色及全域整合。
  • 導覽策略:實作複雜的網站階層,包含群組、頁籤、錨點、下拉式選單、產品分段、版本控制及多語言支援。
  • 內容撰寫:處理帶有 YAML 前置內容的 MDX 頁面,並利用 Mintlify 專用元件提升閱讀體驗。
  • UI/UX 元件:利用內建元件,例如摺疊面板 (Accordion)、頁籤 (Tabs)、步驟 (Steps)、程式碼組 (CodeGroup)、提示框 (Note, Info, Tip, Warning, Check) 及 API 專用欄位 (ParamField, ResponseField)。
  • API 文件:簡化將 OpenAPI 規格整合至文件網站的流程,以自動生成互動式 API 參考。
  • 資源管理:協調內部連結、圖片路徑及專案結構內的靜態資源管理。
  • CLI 自動化:執行必要的維護任務,例如透過 Mintlify CLI 進行驗證、檢查斷掉的連結 (broken-links) 及進行無障礙檢測 (a11y)。

使用注意事項與限制:

  • 請隨時參考官方 mintlify.com/docs 以取得最新的元件語法與設定結構。
  • 優先使用內建元件庫而非自訂 CSS,以確保平台行為的一致性。
  • 在考慮使用 custom.css 進行排版覆寫前,請務必先檢查 docs.json 設定。
  • 確保所有 API 參考皆透過正確設定的 openapi.yml 檔案進行連結,以維持與後端實作的同步。
  • 對於大型文件專案,請使用 snippets 處理可重複使用的內容,但應避免過度參數化,以維持程式碼庫的可維護性。
  • 此技能需要 Node.js 環境才能執行如 mint dev, mint validate 及 mint rename 等 CLI 指令。

倉庫統計

Star 數
9,494
Fork 數
851
Open Issue 數
533
主要語言
Python
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月1日 上午06:59
在 GitHub 查看