インストール
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 が動き、公式インストールコマンドはこの1本 npm i -g mint だけと受け入れる人。これはグローバル CLI であり、スキルマーケットのパッケージではない。skills add に書き換えない。
ブラウザで読むだけなら
https://mintlify.com/docs
ドキュメントを直す予定もローカルプレビューを開く予定もなければ、CLI は不要。初回はローカルプレビューだけにする。このページに出ていない本番反映コマンドは実行しない。このページはプログラミングクライアントを名指ししていない。プレビューはブラウザで見ればよい。
3分で最初の試行
公式インストール経路はこの1本だけ:
npm i -g mint
グローバルインストールはこのマシンのコマンドラインを変える。グローバルパッケージを受け入れるか先に確認する。プラグインやマーケットを探さない。
前提条件:Node/npm が入っていること。今の作業ディレクトリがドキュメントルート、つまり docs.json が見える層であること。そのファイルがまだなければ、先に公式ドキュメントリポジトリをクローンする。記載のない形式の docs.json を自分で作らない。
そのルートで次を実行する:
mint dev
これはローカルプレビューを起動し、このマシンのプロセスである。ポートがローカルアクセス専用であることを確認してから実行する。表示されたローカルアドレスをブラウザで開き、1ページが描画されるか見る。
成功の合図:mint コマンドが使え、mint dev のあとブラウザに docs.json に対応するドキュメントツリーが見え、docs.json が見つからないエラーではないこと。ドキュメントルートにいないと出たら、docs.json を含むディレクトリへ cd して再実行する。記載のない引数は足さない。mint がなければ npm i -g mint に戻る。書いていないパッケージ名に変えない。
使用例
例1:Mint CLI を入れる。公式は npm i -g mint で入れ、ドキュメント変更をローカルプレビューすると書く。入れたら端末で mint を実行し、PATH に入ったことを確認する。これはグローバル副作用である。信頼できない環境でむやみに入れない。このページにバージョン番号も npx mint 代替もない。欠けているならこのグローバルインストールだけ使う。
例2:ドキュメントルートでプレビューする。公式はドキュメントルート(docs.json がある場所)で mint dev を実行すると書く。既存 md ページの見出しまたは段落を直し、保存後にローカルプレビューが更新されるか見る。初回に本番反映のプッシュはしない。このページにホットリロードの詳細もデフォルトポートもない。プレビューアドレスはコマンドライン出力に従い、推測しない。
利用の境界
これは公式ドキュメントリポジトリと CLI プレビューであり、汎用の静的サイト生成器ではない。docs.json がなければ mint dev に公式の起点はない。
公式インストールは npm i -g mint だけ。mint dev はプレビューであり、2つ目のインストーラではない。スキルマーケットインストールを捏造しない。公開済みサイトは読み取り専用の参照であり、インストール元ではない。
グローバル導入と dev 起動はどちらも副作用がある。先にディレクトリを確認する。このページにデプロイ、ホスティング、独自ドメインの手順はない。書いていない本番反映はしない。mint の他のサブコマンドも列挙されていない。出ていないコマンドを推測しない。