Skip to content

Commit c6ff0c8

Browse files
committed
add upgrading steps
1 parent 0d91ea5 commit c6ff0c8

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

settings.mdx

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1396,3 +1396,50 @@ See [Themes](themes) for more information.
13961396
```
13971397
</Tab>
13981398
</Tabs>
1399+
1400+
## Upgrading from `mint.json`
1401+
1402+
If your docs project uses the deprecated `mint.json` file, follow these steps to upgrade to `docs.json`.
1403+
1404+
<Steps>
1405+
<Step title="Install or update the CLI">
1406+
If you haven't installed the [CLI](/installation), install it now:
1407+
1408+
<CodeGroup>
1409+
1410+
```bash npm
1411+
npm i -g mint
1412+
```
1413+
1414+
1415+
```bash yarn
1416+
yarn global add mint
1417+
```
1418+
1419+
1420+
```bash pnpm
1421+
pnpm add -g mint
1422+
```
1423+
1424+
</CodeGroup>
1425+
1426+
If you already have the CLI installed, make sure it is up to date:
1427+
1428+
```bash
1429+
mint update
1430+
```
1431+
1432+
</Step>
1433+
<Step title="Create your docs.json file">
1434+
In your docs repository, run:
1435+
1436+
```bash
1437+
mint upgrade
1438+
```
1439+
1440+
This command will create a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.
1441+
</Step>
1442+
<Step title="Delete your mint.json file">
1443+
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
1444+
</Step>
1445+
</Steps>

0 commit comments

Comments
 (0)