1
このリポジトリをローカルにクローンします。(詳細省略)
2
ツールをデバイスにインストールする必要があります。
npm i -g mintlify
必要に応じて
npm i @mintlify/cli
3
Mintlifyにユーザー登録する必要があります。
パーソナルユースでも登録の際はあくまでも(個人)ですが、GitHubに base Repository を設置するときはGitHubの(会社/団体)と(個人)のアカウントが両方必要です
詳細は下記(オフィシャルサイトのドキュメント)を確認して行ってください
4
編集を開始します。
ローカル環境(ワーキングディレクトリ)で次のコマンドにより
mintlify dev --port 3333
インスタンス(サーバー)を立ち上げプレビューします。
5
編集画面(ダッシュボード)へは右上のDashboardボタンからアクセスします。
👍 以上でドキュメント(コンテンツ)を新規作成しWEB公開できます。
😊 是非お試しください。
なお、このリポジトリには公開コンテンツを ./mintlify-docs に格納しています。
サイト構成やファイル配置の参考にしてください。
最初に'mint.json'を学びましょう。
公開URL:https://watanabe3ti.mintlify.app/
以下はオフィシャルサイトのコンテンツと同じです。
Click on Use this template
to copy the Mintlify starter kit. The starter kit contains examples including
-
Guide pages
-
Navigation
-
Customizations
-
API Reference pages
-
Use of popular components
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i -g mintlify
Run the following command at the root of your documentation (where mint.json is)
mintlify dev
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
-
Mintlify dev isn't running - Run
mintlify install
it'll re-install dependencies. -
Page loads as a 404 - Make sure you are running in a folder with
mint.json