Skip to content

Add mint scrape openapi CLI command #4113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify-development wants to merge 1 commit into from
+47 −0
Closed

Add mint scrape openapi CLI command #4113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions es/migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,18 @@ Esta guía te ayuda a trasladar tu documentación existente a Mintlify. Elige la
mintlify-scrape openapi-file [openApiFilename]
```

También puedes usar el comando CLI:

```bash
mint scrape openapi <openApiFilename o URL>
```

| Flag | Descripción |
| --- | --- |
| `--outDir` | La carpeta en la que escribir los archivos MDX creados. |
| `--overwrite` | Sobrescribir archivos existentes. |
| `--no-writeFiles` | Mostrar sugerencias de navegación sin escribir archivos. |

### Añade el contenido preparado a tu proyecto de Mintlify

Después de extraer el contenido de tu plataforma de documentación existente, estás listo para crear tu documentación en Mintlify.
Expand Down
12 changes: 12 additions & 0 deletions fr/migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,18 @@ Ce guide vous aide à migrer votre documentation existante vers Mintlify. Optez
mintlify-scrape openapi-file [openApiFilename]
```

Vous pouvez également utiliser la commande CLI :

```bash
mint scrape openapi <openApiFilename ou URL>
```

| Flag | Description |
| --- | --- |
| `--outDir` | Le dossier dans lequel écrire les fichiers MDX créés. |
| `--overwrite` | Écraser les fichiers existants. |
| `--no-writeFiles` | Afficher les suggestions de navigation sans écrire de fichiers. |

### Ajouter le contenu préparé à votre projet Mintlify

Après avoir extrait le contenu de votre plateforme de documentation existante, vous êtes prêt à créer votre documentation sur Mintlify.
Expand Down
11 changes: 11 additions & 0 deletions migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,17 @@ mint scrape site https://your-docs-site.com --filter=/docs
mintlify-scrape openapi-file [openApiFilename]
```

You can also use the CLI command:
```bash
mint scrape openapi <openApiFilename or URL>
```

| Flag | Description |
| --- | --- |
| `--outDir` | The folder in which to write created MDX files. |
| `--overwrite` | Overwrite existing files. |
| `--no-writeFiles` | Output navigation suggestions without writing files. |

### Add prepared content to your Mintlify project

After scraping your existing documentation platform, you are ready to build your docs on Mintlify.
Expand Down
12 changes: 12 additions & 0 deletions zh/migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,18 @@ keywords: ["migration", "Docusaurus", "ReadMe", "import"]
mintlify-scrape openapi-file [openApiFilename]
```

你也可以使用 CLI 命令：

```bash
mint scrape openapi <openApiFilename 或 URL>
```

| Flag | 描述 |
| --- | --- |
| `--outDir` | 写入创建的 MDX 文件的文件夹。 |
| `--overwrite` | 覆盖现有文件。 |
| `--no-writeFiles` | 输出导航建议但不写入文件。 |

### 将准备好的内容添加到您的 Mintlify 项目

抓取现有文档平台后,您就可以在 Mintlify 上构建文档了。
Expand Down