Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,58 @@ mint migrate-mdx

This command converts individual MDX endpoint pages to autogenerated pages defined in your `docs.json`, moves MDX content to the `x-mint` extension in your OpenAPI specification, and updates your navigation. See [Migrating from MDX](/guides/migrating-from-mdx) for detailed information.

### Upgrade configuration

If you have an existing `mint.json` configuration file, upgrade it to the current `docs.json` format:

```bash
mint upgrade
```

This command converts your `mint.json` to `docs.json` with the new configuration structure. For more details, see [Global settings](/organize/settings).

### Scrape documentation

Import content from external documentation sites using the scrape commands. These commands are useful for migrating existing documentation to Mintlify.

**Scrape an entire documentation site:**

```bash
mint scrape site <url>
```

| Option | Description |
| --- | --- |
| `--filter`, `-f` | Only scrape URLs matching this path filter (for example, `/docs` matches `/docs` and `/docs/*`). |

**Scrape a single documentation page:**

```bash
mint scrape page <url>
```

**Generate MDX files from an OpenAPI spec:**

```bash
mint scrape openapi <filename-or-url>
```

| Option | Description | Default |
| --- | --- | --- |
| `--writeFiles`, `-w` | Write the generated frontmatter files to disk. | `true` |
| `--outDir`, `-o` | The folder to write generated files. | Current directory |
| `--overwrite` | Overwrite existing files. | `false` |

For more information, see [Migration](/migration).

### Show CLI version

Display the current version of the CLI and client:

```bash
mint version
```

## Formatting

While developing locally, we recommend using extensions in your IDE to recognize and format MDX files.
Expand Down