Mintlify怎麼用 AI文件網站生成工具教程

Mintlify是一個AI文件網站生成工具，可以從程式碼倉庫自動生成產品文件，開發者喜歡用。下面從建立專案開始，帶你把倉庫接入、整理頁面、預覽併發布。先準備一個 GitHub 帳號，以及已有的產品說明或 API 程式碼；首次使用也可以從示例模板起步。

步驟一：註冊並建立文件專案

開啟 Mintlify 官網，點選 Get started 或 Sign up，用 Google 帳號註冊並進入控制檯。按頁面提示新建文件專案；如果出現模板選項，選擇 Starter Kit，先用現成頁面熟悉結構。建立後記下專案名稱，進入專案總覽頁，確認能看到文件站點的預覽入口，再繼續連線程式碼倉庫。

步驟二：準備 GitHub 文件倉庫

登入 GitHub，新建一個專門放文件的倉庫，或選已有倉庫。若剛開始，複製 Mintlify Starter Kit 模板最省事：在模板倉庫頁面點選 Use this template，再建立自己的倉庫。模板裡通常有首頁、指南、API 示例和 docs.json 配置；這些檔案就是後續改內容、改導航的基礎。

步驟三：把倉庫連線到 Mintlify

回到 Mintlify 控制檯，選擇 Connect repository 或連線 GitHub，按授權頁提示允許應用訪問目標倉庫。隨後從列表中選剛才建立的文件倉庫，並確認預設分支，例如 main。連線完成後檢查專案設定裡的倉庫名稱和分支是否正確；如果倉庫沒顯示，先確認 GitHub 授權範圍包含它。

步驟四：整理首頁和導航

在倉庫檔案列表中開啟 index.mdx，替換示例標題、簡介和快速入口，寫清產品用途、適用物件與第一步操作。再開啟 docs.json，找到 navigation 區域，把模板選單項改成自己的章節名稱和頁面路徑。儲存後提交變更；路徑要和實際檔案一致，否則選單點選後容易出現空白頁或 404。

步驟五：用 AI 起草功能文件

先挑一個具體功能，例如登入、建立專案或呼叫介面，把對應程式碼、引數和預期結果作為依據。進入 Mintlify 的編輯或 AI 寫作入口，輸入明確指令：要求按前置條件、操作步驟、示例和常見錯誤組織內容。生成後逐段核對欄位名、命令和返回值，再將確認過的文字放進對應 MDX 頁面。

步驟六：編寫 API 頁面並加示例

在倉庫中新建 API 說明頁面，先寫介面用途、請求方法、路徑、認證方式和必填引數，再新增請求與響應示例。若專案已有 OpenAPI 檔案，可按 Mintlify 當前支援的匯入或引用方式接入，避免手動抄寫欄位。釋出前用真實介面對照示例，尤其檢查引數型別、錯誤碼和鑑權頭，AI 草稿不能代替驗證。

步驟七：本地預覽並修正問題

想在釋出前檢查頁面，可在本地安裝 Node.js，然後開啟終端進入文件倉庫根目錄，執行 npm i -g mint 安裝 CLI，再執行 mint dev。瀏覽器開啟終端顯示的本地地址，逐頁檢查選單、連結、程式碼塊和手機螢幕效果。頁面報錯時先確認當前目錄有 docs.json，修正後重新整理預覽。

步驟八：提交併釋出網站

檢查完成後，把修改提交併推送到連線的預設分支。首次部署時按控制檯提示設定站點地址或自定義域名；之後推送更新，Mintlify 會根據專案連線配置構建並部署。開啟線上網址檢查首頁和關鍵頁面，確認圖片、連結與導航正常；若沒更新，檢視部署狀態和構建日誌。

步驟九：持續維護文件內容