mint 4.2.459 → 4.2.461
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -35
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -52,12 +52,12 @@ mint dev
|
|
|
52
52
|
|
|
53
53
|
**Options**
|
|
54
54
|
|
|
55
|
-
| Flag
|
|
56
|
-
|
|
57
|
-
| `--port <number>`
|
|
58
|
-
| `--no-open`
|
|
59
|
-
| `--groups <group...>` | Mock user groups for local testing
|
|
60
|
-
| `--disable-openapi`
|
|
55
|
+
| Flag | Description | Default |
|
|
56
|
+
| --------------------- | --------------------------------------- | ------- |
|
|
57
|
+
| `--port <number>` | Port to run the preview on | `3000` |
|
|
58
|
+
| `--no-open` | Skip opening the preview in the browser | — |
|
|
59
|
+
| `--groups <group...>` | Mock user groups for local testing | — |
|
|
60
|
+
| `--disable-openapi` | Disable OpenAPI file generation | — |
|
|
61
61
|
|
|
62
62
|
**Custom port**
|
|
63
63
|
|
|
@@ -88,10 +88,10 @@ mint validate
|
|
|
88
88
|
|
|
89
89
|
**Options**
|
|
90
90
|
|
|
91
|
-
| Flag
|
|
92
|
-
|
|
91
|
+
| Flag | Description |
|
|
92
|
+
| --------------------- | ------------------------------- |
|
|
93
93
|
| `--groups <group...>` | Mock user groups for validation |
|
|
94
|
-
| `--disable-openapi`
|
|
94
|
+
| `--disable-openapi` | Disable OpenAPI file generation |
|
|
95
95
|
|
|
96
96
|
#### `mint broken-links`
|
|
97
97
|
|
|
@@ -103,11 +103,11 @@ mint broken-links
|
|
|
103
103
|
|
|
104
104
|
**Options**
|
|
105
105
|
|
|
106
|
-
| Flag
|
|
107
|
-
|
|
108
|
-
| `--check-anchors`
|
|
109
|
-
| `--check-external` | Also check external links for broken URLs
|
|
110
|
-
| `--check-snippets` | Also check links inside `<Snippet>` components
|
|
106
|
+
| Flag | Description |
|
|
107
|
+
| ------------------ | ------------------------------------------------------------------------- |
|
|
108
|
+
| `--check-anchors` | Also validate anchor links like `link-path#section` against heading slugs |
|
|
109
|
+
| `--check-external` | Also check external links for broken URLs |
|
|
110
|
+
| `--check-snippets` | Also check links inside `<Snippet>` components |
|
|
111
111
|
|
|
112
112
|
#### `mint openapi-check <filename>`
|
|
113
113
|
|
|
@@ -128,9 +128,9 @@ mint a11y
|
|
|
128
128
|
|
|
129
129
|
**Options**
|
|
130
130
|
|
|
131
|
-
| Flag
|
|
132
|
-
|
|
133
|
-
| `--skip-contrast` | Skip color contrast checks
|
|
131
|
+
| Flag | Description |
|
|
132
|
+
| ----------------- | ----------------------------------------- |
|
|
133
|
+
| `--skip-contrast` | Skip color contrast checks |
|
|
134
134
|
| `--skip-alt-text` | Skip alt text checks on images and videos |
|
|
135
135
|
|
|
136
136
|
### Create and manage content
|
|
@@ -146,11 +146,11 @@ mint new my-docs
|
|
|
146
146
|
|
|
147
147
|
**Options**
|
|
148
148
|
|
|
149
|
-
| Flag
|
|
150
|
-
|
|
151
|
-
| `--theme <name>` | Theme for the documentation site
|
|
152
|
-
| `--name <name>`
|
|
153
|
-
| `--force`
|
|
149
|
+
| Flag | Description |
|
|
150
|
+
| ---------------- | ----------------------------------- |
|
|
151
|
+
| `--theme <name>` | Theme for the documentation site |
|
|
152
|
+
| `--name <name>` | Name of the documentation project |
|
|
153
|
+
| `--force` | Initialize in a non-empty directory |
|
|
154
154
|
|
|
155
155
|
#### `mint rename <from> <to>`
|
|
156
156
|
|
|
@@ -162,8 +162,8 @@ mint rename introduction.mdx overview.mdx
|
|
|
162
162
|
|
|
163
163
|
**Options**
|
|
164
164
|
|
|
165
|
-
| Flag
|
|
166
|
-
|
|
165
|
+
| Flag | Description |
|
|
166
|
+
| --------- | ---------------------------- |
|
|
167
167
|
| `--force` | Rename files and skip errors |
|
|
168
168
|
|
|
169
169
|
#### `mint scrape <url>`
|
|
@@ -176,8 +176,8 @@ mint scrape https://example.com/docs
|
|
|
176
176
|
|
|
177
177
|
**Options**
|
|
178
178
|
|
|
179
|
-
| Flag
|
|
180
|
-
|
|
179
|
+
| Flag | Description |
|
|
180
|
+
| ----------------- | -------------------------------------------------------------------------------- |
|
|
181
181
|
| `--filter <path>` | Only scrape URLs matching this path (e.g. `/docs` matches `/docs` and `/docs/*`) |
|
|
182
182
|
|
|
183
183
|
#### `mint scrape page <url>`
|
|
@@ -199,10 +199,10 @@ mint scrape openapi https://petstore3.swagger.io/api/v3/openapi.json
|
|
|
199
199
|
|
|
200
200
|
**Options**
|
|
201
201
|
|
|
202
|
-
| Flag
|
|
203
|
-
|
|
204
|
-
| `--outDir <path>` | Folder to write the generated files | —
|
|
205
|
-
| `--overwrite`
|
|
202
|
+
| Flag | Description | Default |
|
|
203
|
+
| ----------------- | ----------------------------------- | ------- |
|
|
204
|
+
| `--outDir <path>` | Folder to write the generated files | — |
|
|
205
|
+
| `--overwrite` | Overwrite existing files | `false` |
|
|
206
206
|
|
|
207
207
|
#### `mint migrate-mdx`
|
|
208
208
|
|
|
@@ -229,11 +229,11 @@ mint export --output docs.zip
|
|
|
229
229
|
|
|
230
230
|
**Options**
|
|
231
231
|
|
|
232
|
-
| Flag
|
|
233
|
-
|
|
234
|
-
| `--output <path>`
|
|
235
|
-
| `--groups <group...>` | Mock user groups for export
|
|
236
|
-
| `--disable-openapi`
|
|
232
|
+
| Flag | Description | Default |
|
|
233
|
+
| --------------------- | ------------------------------- | ------------ |
|
|
234
|
+
| `--output <path>` | Output zip file path | `export.zip` |
|
|
235
|
+
| `--groups <group...>` | Mock user groups for export | — |
|
|
236
|
+
| `--disable-openapi` | Disable OpenAPI file generation | — |
|
|
237
237
|
|
|
238
238
|
### CLI management
|
|
239
239
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mint",
|
|
3
|
-
"version": "4.2.
|
|
3
|
+
"version": "4.2.461",
|
|
4
4
|
"description": "The Mintlify CLI",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
"clean:all": "rimraf node_modules"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@mintlify/cli": "4.0.
|
|
33
|
+
"@mintlify/cli": "4.0.1064"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
36
|
"rimraf": "5.0.1"
|
|
37
37
|
},
|
|
38
|
-
"gitHead": "
|
|
38
|
+
"gitHead": "dbb1d51caa0d27cb7ab44f8a5e237b0782bb96d4"
|
|
39
39
|
}
|