From 657683100000bdb95b90926207377ef5d348e436 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Apr 2026 17:44:01 +0000 Subject: [PATCH] Remove docs for deprecated CLI commands: scrape, rename, migrate-mdx Generated-By: mintlify-agent --- api-playground/openapi-setup.mdx | 12 ------- guides/migrating-from-mdx.mdx | 43 ++--------------------- installation.mdx | 60 +------------------------------- migration.mdx | 12 +------ 4 files changed, 4 insertions(+), 123 deletions(-) diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index e3a79f5fc..43b275c65 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -446,18 +446,6 @@ version: "version-string" (not required) The method and path must exactly match your OpenAPI spec. If you have multiple OpenAPI specifications, include the path to the correct specification in your reference. You can also reference external OpenAPI URLs in `docs.json`. -#### Autogenerate endpoint pages - -To autogenerate MDX files from your OpenAPI specification, use the Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping). - -```bash -npx @mintlify/scraping@latest openapi-file -o -``` - - - Add the `-o` flag to specify a folder to populate the files into. If a folder is not specified, the files populate in the working directory. - - ### Document data models Create a page for each data structure defined in your OpenAPI specification's `components.schemas` using the `openapi-schema` field in the frontmatter. diff --git a/guides/migrating-from-mdx.mdx b/guides/migrating-from-mdx.mdx index 8b2779452..6945da7d7 100644 --- a/guides/migrating-from-mdx.mdx +++ b/guides/migrating-from-mdx.mdx @@ -2,53 +2,14 @@ title: "Migrating MDX API pages to OpenAPI navigation" sidebarTitle: "Migrate from MDX to OAS" description: "Migrate your manually written MDX API pages to automated OpenAPI-generated documentation with flexible navigation and endpoint grouping." -keywords: ["API migration", "mint migrate-mdx", "OpenAPI migration", "x-mint extension"] +keywords: ["API migration", "OpenAPI migration", "x-mint extension"] --- If you are currently using individual MDX pages for your API endpoints, you can migrate to autogenerating pages from your OpenAPI specification while retaining the customizability of individual pages. This can help you reduce the number of files you need to maintain and improve the consistency of your API documentation. You can define metadata and content for each endpoint in your OpenAPI specification and organize endpoints where you want them in your navigation. -## CLI migration - -The `mint migrate-mdx` command is the recommended way to migrate from MDX endpoint pages to autogenerated pages. - -This command: -- Parses your `docs.json` navigation structure. -- Identifies MDX pages that generate OpenAPI endpoint pages. -- Extracts content from MDX files and moves it to the `x-mint` extension in your OpenAPI specification. -- Updates your `docs.json` to reference the OpenAPI endpoints directly instead of MDX files. -- Deletes the original MDX endpoint files. - - -If you already have `x-mint` defined for an endpoint and also have an MDX page with content for that endpoint, the MDX content overwrites existing `x-mint` settings. - -If you have multiple MDX pages for the same endpoint with different content, the script uses the content from the page that appears last in your `docs.json`. - -The migration tool does not support previewing changes before applying them. - - - - - Ensure your OpenAPI specification is valid and includes all endpoints you want to document. - - Any MDX pages you want to migrate must have the `openapi:` frontmatter referencing an endpoint. - - - Validate your OpenAPI file using the [Swagger Editor](https://editor.swagger.io/) or [Mint CLI](https://www.npmjs.com/package/mint). - - - - If needed, install or update the [Mint CLI](/installation). - - - ```bash - mint migrate-mdx - ``` - - - -## Manual migration steps +## Migration steps diff --git a/installation.mdx b/installation.mdx index 68eca503e..2265979b4 100644 --- a/installation.mdx +++ b/installation.mdx @@ -17,7 +17,7 @@ keywords: ["CLI", "npm", "local development", "Node.js", "pnpm", "mint dev", "br Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and features, and catch issues like broken links or accessibility problems. -The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats. +The CLI also has utilities for maintaining your documentation, including commands to validate OpenAPI specifications and check for broken links or accessibility issues. ## Prerequisites @@ -258,30 +258,6 @@ mint workflow The CLI prompts you for a name, trigger type, and other settings, then creates a `.md` file in `.mintlify/workflows/`. -### Rename files - -Rename and update all references to files with the following command: - -```bash -mint rename -``` - -Use `--force` to rename files and skip errors: - -```bash -mint rename --force -``` - -### Migrate MDX endpoint pages - -Migrate MDX endpoint pages to autogenerated pages from your OpenAPI specification with the following command: - -```bash -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. - ### Export for offline viewing Export your entire documentation site as a self-contained zip archive for offline viewing and distribution: @@ -298,40 +274,6 @@ mint export --output customer-docs.zip --groups enterprise See [Offline export](/deploy/export) for details on all options and distributing the exported archive. -### Import content - -Scrape content from an external documentation site or OpenAPI specification using the `mint scrape` commands. This is useful when you migrate your documentation from another platform to Mintlify. - -**Import an entire site:** - -```bash -mint scrape -``` - -Use the `--filter` (or `-f`) flag to limit scraping to URLs matching a specific path prefix: - -```bash -mint scrape --filter= -``` - -**Import a single page:** - -```bash -mint scrape page -``` - -**Generate pages from an OpenAPI spec:** - -```bash -mint scrape openapi -``` - -| Flag | Description | -| --- | --- | -| `--outDir` | Directory to write generated files. Defaults to `./docs`. | -| `--overwrite` | Overwrite existing files. | -| `--no-writeFiles` | Preview output without writing files. | - ### Upgrade configuration Convert a `mint.json` configuration file to the current `docs.json` format: diff --git a/migration.mdx b/migration.mdx index de2d45b10..8b46c2123 100644 --- a/migration.mdx +++ b/migration.mdx @@ -170,17 +170,7 @@ To migrate your content to Mintlify, you need: 1. If your content is already in Markdown format, copy the content to your Mintlify project. Otherwise, convert your content to MDX format. 2. Create your `docs.json` referencing the paths to your Markdown pages. -3. If you have OpenAPI specifications, add them to your `docs.json` and configure the API playground. You can also generate MDX pages from your spec using the `mint scrape openapi` command: - -```bash -mint scrape openapi -``` - -| Flag | Description | -| --- | --- | -| `--outDir` | Directory to write generated files. Defaults to `./docs`. | -| `--overwrite` | Overwrite existing files. | -| `--no-writeFiles` | Preview output without writing files. | +3. If you have OpenAPI specifications, add them to your `docs.json` and configure the API playground. See [OpenAPI setup](/api-playground/openapi-setup) for more information. If you migrate your content as `.md` files, convert them to `.mdx` to support interactive features like React components.