安装
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 的其他子命令,未出现的命令不要猜。