@mintlify/validation 0.1.297 → 0.1.299
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 +3 -3
- package/dist/mint-config/schemas/v1/config.d.ts +7 -7
- package/dist/mint-config/schemas/v1/versions.d.ts +5 -5
- package/dist/mint-config/schemas/v2/index.d.ts +317 -19812
- package/dist/mint-config/schemas/v2/properties/navigation/anchors.d.ts +2 -2
- package/dist/mint-config/schemas/v2/properties/navigation/anchors.js +23 -9
- package/dist/mint-config/schemas/v2/properties/navigation/divisionNav.d.ts +27 -6
- package/dist/mint-config/schemas/v2/properties/navigation/dropdown.d.ts +2 -2
- package/dist/mint-config/schemas/v2/properties/navigation/dropdown.js +23 -9
- package/dist/mint-config/schemas/v2/properties/navigation/global.d.ts +2 -264
- package/dist/mint-config/schemas/v2/properties/navigation/global.js +2 -1
- package/dist/mint-config/schemas/v2/properties/navigation/index.d.ts +24 -2912
- package/dist/mint-config/schemas/v2/properties/navigation/languages.d.ts +8 -8
- package/dist/mint-config/schemas/v2/properties/navigation/languages.js +24 -10
- package/dist/mint-config/schemas/v2/properties/navigation/tabs.d.ts +2 -2
- package/dist/mint-config/schemas/v2/properties/navigation/tabs.js +20 -9
- package/dist/mint-config/schemas/v2/properties/navigation/version.d.ts +2 -2
- package/dist/mint-config/schemas/v2/properties/navigation/version.js +23 -9
- package/dist/mint-config/schemas/v2/themes/linden.d.ts +75 -3974
- package/dist/mint-config/schemas/v2/themes/maple.d.ts +75 -3974
- package/dist/mint-config/schemas/v2/themes/mint.d.ts +75 -3974
- package/dist/mint-config/schemas/v2/themes/palm.d.ts +75 -3974
- package/dist/mint-config/schemas/v2/themes/reusable/index.d.ts +21 -2548
- package/dist/mint-config/schemas/v2/themes/willow.d.ts +75 -3974
- package/dist/mint-config/validateConfig.d.ts +170 -7030
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @mintlify/validation
|
|
2
2
|
|
|
3
|
-
`@mintlify/validation` is a small package to validate `
|
|
3
|
+
`@mintlify/validation` is a small package to validate `docs.json` files.
|
|
4
4
|
|
|
5
5
|
# Installation
|
|
6
6
|
|
|
@@ -31,7 +31,7 @@ The package returns an object with the properties `status`, `warnings`, and `err
|
|
|
31
31
|
|
|
32
32
|
`errors` is a string array of errors that will likely break the site.
|
|
33
33
|
|
|
34
|
-
When `status === "error"` you should stop trying to build `mint`, your `
|
|
34
|
+
When `status === "error"` you should stop trying to build `mint`, your `docs.json` file is invalid and the site will crash when building.
|
|
35
35
|
|
|
36
36
|
## Return Value Example
|
|
37
37
|
|
|
@@ -45,7 +45,7 @@ When `status === "error"` you should stop trying to build `mint`, your `mint.jso
|
|
|
45
45
|
|
|
46
46
|
## Documentation
|
|
47
47
|
|
|
48
|
-
Additional documentation on `
|
|
48
|
+
Additional documentation on `docs.json` is available on [Mintlify's website](https://mintlify.com/docs/settings/global).
|
|
49
49
|
|
|
50
50
|
# Community
|
|
51
51
|
|
|
@@ -147,27 +147,27 @@ export declare const mintConfigSchema: z.ZodObject<{
|
|
|
147
147
|
name: z.ZodString;
|
|
148
148
|
url: z.ZodOptional<z.ZodString>;
|
|
149
149
|
default: z.ZodOptional<z.ZodLiteral<true>>;
|
|
150
|
-
locale: z.ZodOptional<z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de"]>>;
|
|
150
|
+
locale: z.ZodOptional<z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de", "ko"]>>;
|
|
151
151
|
}, "strict", z.ZodTypeAny, {
|
|
152
152
|
name: string;
|
|
153
153
|
url?: string | undefined;
|
|
154
154
|
default?: true | undefined;
|
|
155
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
155
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
156
156
|
}, {
|
|
157
157
|
name: string;
|
|
158
158
|
url?: string | undefined;
|
|
159
159
|
default?: true | undefined;
|
|
160
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
160
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
161
161
|
}>]>, "many">, (string | {
|
|
162
162
|
name: string;
|
|
163
163
|
url?: string | undefined;
|
|
164
164
|
default?: true | undefined;
|
|
165
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
165
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
166
166
|
})[], (string | {
|
|
167
167
|
name: string;
|
|
168
168
|
url?: string | undefined;
|
|
169
169
|
default?: true | undefined;
|
|
170
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
170
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
171
171
|
})[]>>;
|
|
172
172
|
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
173
173
|
codeBlock: z.ZodOptional<z.ZodObject<{
|
|
@@ -908,7 +908,7 @@ export declare const mintConfigSchema: z.ZodObject<{
|
|
|
908
908
|
name: string;
|
|
909
909
|
url?: string | undefined;
|
|
910
910
|
default?: true | undefined;
|
|
911
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
911
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
912
912
|
})[] | undefined;
|
|
913
913
|
metadata?: Record<string, string> | undefined;
|
|
914
914
|
codeBlock?: {
|
|
@@ -1144,7 +1144,7 @@ export declare const mintConfigSchema: z.ZodObject<{
|
|
|
1144
1144
|
name: string;
|
|
1145
1145
|
url?: string | undefined;
|
|
1146
1146
|
default?: true | undefined;
|
|
1147
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
1147
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
1148
1148
|
})[] | undefined;
|
|
1149
1149
|
metadata?: Record<string, string> | undefined;
|
|
1150
1150
|
codeBlock?: {
|
|
@@ -3,25 +3,25 @@ export declare const versionsSchema: z.ZodEffects<z.ZodArray<z.ZodUnion<[z.ZodSt
|
|
|
3
3
|
name: z.ZodString;
|
|
4
4
|
url: z.ZodOptional<z.ZodString>;
|
|
5
5
|
default: z.ZodOptional<z.ZodLiteral<true>>;
|
|
6
|
-
locale: z.ZodOptional<z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de"]>>;
|
|
6
|
+
locale: z.ZodOptional<z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de", "ko"]>>;
|
|
7
7
|
}, "strict", z.ZodTypeAny, {
|
|
8
8
|
name: string;
|
|
9
9
|
url?: string | undefined;
|
|
10
10
|
default?: true | undefined;
|
|
11
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
11
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
12
12
|
}, {
|
|
13
13
|
name: string;
|
|
14
14
|
url?: string | undefined;
|
|
15
15
|
default?: true | undefined;
|
|
16
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
16
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
17
17
|
}>]>, "many">, (string | {
|
|
18
18
|
name: string;
|
|
19
19
|
url?: string | undefined;
|
|
20
20
|
default?: true | undefined;
|
|
21
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
21
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
22
22
|
})[], (string | {
|
|
23
23
|
name: string;
|
|
24
24
|
url?: string | undefined;
|
|
25
25
|
default?: true | undefined;
|
|
26
|
-
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
|
|
26
|
+
locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | "ko" | undefined;
|
|
27
27
|
})[]>;
|