安裝
npm i -g mint適合誰
如果你在維護 Mintlify 文件,希望改完先在本機看效果,而不是直接推到線上,這個官方文件儲存庫對得上。它是 Official Mintlify documentation。儲存庫見
https://github.com/mintlify/docs
已發布的文件站見
https://mintlify.com/docs
CLI 套件見
https://www.npmjs.com/package/mint
更合適的人已經有一份帶 docs.json 的文件目錄(可以是複製下來的本儲存庫,或你自己的 Mintlify 專案),本機能跑 npm,並且接受只走官方這一條安裝命令:npm i -g mint。這是全域 CLI,不是技能市集套件,不要改寫成 skills add。
若你只想在瀏覽器讀
https://mintlify.com/docs
並不打算改文件或開本機預覽,就不必裝 CLI。第一次請只做本機預覽,不要執行未在本頁出現的上線命令。本頁沒有點名任何程式用戶端;預覽在瀏覽器裡看即可。
3 分鐘完成第一次嘗試
只走官方這一條安裝路徑:
npm i -g mint
全域安裝會改本機命令列,先確認你接受全域套件。不要另找外掛或市集。
前置條件:已安裝 Node/npm;當前工作目錄是文件根,也就是能看到 docs.json 的那一層。若還沒有這份檔案,先複製官方文件儲存庫,不要自己編一份未記載格式的 docs.json。
然後在該根目錄執行:
mint dev
這會啟動本機預覽,屬於本機行程。先確認連接埠只在本機存取,再執行。瀏覽器開啟它給出的本機位址,檢查一頁文件是否渲染。
成功訊號:mint 命令可用,且 mint dev 後能在瀏覽器看到與 docs.json 對應的文件樹,而不是報找不到 docs.json。若提示不在文件根,cd 到含 docs.json 的目錄再跑,不要加未記載的參數。若 mint 不存在,回到 npm i -g mint,不要換未寫出的套件名。
使用案例
案例一:安裝 Mint CLI。官方寫明用 npm i -g mint 安裝,以便本機預覽文件改動。裝完在終端執行 mint,確認命令已進 PATH。這是全域副作用,不要在不信任的環境亂裝。本頁沒有寫版本號或 npx mint 替代;缺了就只用這條全域安裝。
案例二:在文件根預覽。官方寫明在文件根(有 docs.json 處)執行 mint dev。做法是改一個現有 md 頁面的標題或段落,儲存後看本機預覽是否更新。不要在第一次嘗試裡做上線推送。本頁沒有寫出熱更新細節或預設連接埠;預覽位址以命令列輸出為準,不要猜。
使用邊界
這是官方文件儲存庫加 CLI 預覽,不是通用靜態站點產生器。沒有 docs.json,mint dev 沒有官方起點。
官方安裝只有 npm i -g mint。mint dev 是預覽,不是第二條安裝器。不要發明技能市集安裝。已發布站點是唯讀參考,不是安裝源。
全域裝包和啟動 dev 都有副作用。先確認目錄。本頁沒有給出部署、託管或自訂網域步驟;沒寫到的上線動作不要做。也沒有列出 mint 的其他子命令,未出現的命令不要猜。