0.1.391 • Published 5 months ago

@mintlify/validation v0.1.391

Weekly downloads
-
License
Elastic-2.0
Repository
-
Last release
5 months ago

@mintlify/validation

@mintlify/validation is a small package to validate docs.json files.

Installation

npm install @mintlify/validation

Usage

import mintValidation from "@mintlify/validation"

const configObject = { name: "Site Name", navigation: [] }

mintValidation.validateMintConfig(configObject)
mintValidation.validateDocsConfig(configObject)

This package assumes you have already loaded a config object into a JavaScript object.

Return Values

The package returns an object with the properties status, warnings, and errors.

status can be one of: "success", "error".

warnings is a string array with warnings the user should know but are not expected to break the site.

errors is a string array of errors that will likely break the site.

When status === "error" you should stop trying to build mint, your docs.json file is invalid and the site will crash when building.

Return Value Example

{
    "status": "error",
    "warnings": ["Navigation is an empty array, no pages will be shown"],
    "errors": ["Mintlify does not support .ico favicons, use .svg or .png instead."]
}

Documentation

Additional documentation on docs.json is available on Mintlify's website.

Community

Join our Discord community if you have questions or just want to chat:

npm.io

Built with 💚 by the Mintlify community.

0.1.239

10 months ago

0.1.359

6 months ago

0.1.238

10 months ago

0.1.356

6 months ago

0.1.235

10 months ago

0.1.355

6 months ago

0.1.234

10 months ago

0.1.358

6 months ago

0.1.237

10 months ago

0.1.357

6 months ago

0.1.236

10 months ago

0.1.352

6 months ago

0.1.231

10 months ago

0.1.351

6 months ago

0.1.230

10 months ago

0.1.354

6 months ago

0.1.233

10 months ago

0.1.353

6 months ago

0.1.232

10 months ago

0.1.350

6 months ago

0.1.249

9 months ago

0.1.367

5 months ago

0.1.246

9 months ago

0.1.366

5 months ago

0.1.245

9 months ago

0.1.369

5 months ago

0.1.248

9 months ago

0.1.368

5 months ago

0.1.247

9 months ago

0.1.363

5 months ago

0.1.242

10 months ago

0.1.362

5 months ago

0.1.241

10 months ago

0.1.365

5 months ago

0.1.244

9 months ago

0.1.364

5 months ago

0.1.243

9 months ago

0.1.361

6 months ago

0.1.240

10 months ago

0.1.360

6 months ago

0.1.378

5 months ago

0.1.257

9 months ago

0.1.377

5 months ago

0.1.256

9 months ago

0.1.259

9 months ago

0.1.379

5 months ago

0.1.258

9 months ago

0.1.374

5 months ago

0.1.253

9 months ago

0.1.373

5 months ago

0.1.252

9 months ago

0.1.376

5 months ago

0.1.255

9 months ago

0.1.375

5 months ago

0.1.254

9 months ago

0.1.370

5 months ago

0.1.372

5 months ago

0.1.251

9 months ago

0.1.371

5 months ago

0.1.250

9 months ago

0.1.389

5 months ago

0.1.268

9 months ago

0.1.388

5 months ago

0.1.267

9 months ago

0.1.269

9 months ago

0.1.385

5 months ago

0.1.264

9 months ago

0.1.384

5 months ago

0.1.263

9 months ago

0.1.387

5 months ago

0.1.266

9 months ago

0.1.386

5 months ago

0.1.265

9 months ago

0.1.381

5 months ago

0.1.260

9 months ago

0.1.380

5 months ago

0.1.383

5 months ago

0.1.262

9 months ago

0.1.382

5 months ago

0.1.261

9 months ago

0.1.309

8 months ago

0.1.308

8 months ago

0.1.316

8 months ago

0.1.315

8 months ago

0.1.318

8 months ago

0.1.317

8 months ago

0.1.312

8 months ago

0.1.311

8 months ago

0.1.314

8 months ago

0.1.313

8 months ago

0.1.310

8 months ago

0.1.319

8 months ago

0.1.327

7 months ago

0.1.326

7 months ago

0.1.329

7 months ago

0.1.328

7 months ago

0.1.323

7 months ago

0.1.322

8 months ago

0.1.325

7 months ago

0.1.324

7 months ago

0.1.321

8 months ago

0.1.320

8 months ago

0.1.338

7 months ago

0.1.217

11 months ago

0.1.337

7 months ago

0.1.216

11 months ago

0.1.219

11 months ago

0.1.339

7 months ago

0.1.218

11 months ago

0.1.334

7 months ago

0.1.213

12 months ago

0.1.333

7 months ago

0.1.212

12 months ago

0.1.336

7 months ago

0.1.215

11 months ago

0.1.335

7 months ago

0.1.214

11 months ago

0.1.330

7 months ago

0.1.332

7 months ago

0.1.211

12 months ago

0.1.331

7 months ago

0.1.349

6 months ago

0.1.228

10 months ago

0.1.348

6 months ago

0.1.227

10 months ago

0.1.229

10 months ago

0.1.345

7 months ago

0.1.224

11 months ago

0.1.344

7 months ago

0.1.223

11 months ago

0.1.347

6 months ago

0.1.226

10 months ago

0.1.346

6 months ago

0.1.225

11 months ago

0.1.341

7 months ago

0.1.220

11 months ago

0.1.340

7 months ago

0.1.343

7 months ago

0.1.222

11 months ago

0.1.342

7 months ago

0.1.221

11 months ago

0.1.305

8 months ago

0.1.304

8 months ago

0.1.307

8 months ago

0.1.306

8 months ago

0.1.301

8 months ago

0.1.300

8 months ago

0.1.303

8 months ago

0.1.302

8 months ago

0.1.390

5 months ago

0.1.279

9 months ago

0.1.278

9 months ago

0.1.275

9 months ago

0.1.274

9 months ago

0.1.277

9 months ago

0.1.276

9 months ago

0.1.271

9 months ago

0.1.391

5 months ago

0.1.270

9 months ago

0.1.273

9 months ago

0.1.272

9 months ago

0.1.280

9 months ago

0.1.289

9 months ago

0.1.286

9 months ago

0.1.285

9 months ago

0.1.288

9 months ago

0.1.287

9 months ago

0.1.282

9 months ago

0.1.281

9 months ago

0.1.284

9 months ago

0.1.283

9 months ago

0.1.291

9 months ago

0.1.290

9 months ago

0.1.297

9 months ago

0.1.296

9 months ago

0.1.299

8 months ago

0.1.298

9 months ago

0.1.293

9 months ago

0.1.292

9 months ago

0.1.295

9 months ago

0.1.294

9 months ago

0.1.208

1 year ago

0.1.207

1 year ago

0.1.209

12 months ago

0.1.210

12 months ago

0.1.206

1 year ago

0.1.205

1 year ago

0.1.204

1 year ago

0.1.203

1 year ago

0.1.202

1 year ago

0.1.201

1 year ago

0.1.200

1 year ago

0.1.198

1 year ago

0.1.197

1 year ago

0.1.199

1 year ago

0.1.194

1 year ago

0.1.196

1 year ago

0.1.195

1 year ago

0.1.193

1 year ago

0.1.190

1 year ago

0.1.192

1 year ago

0.1.191

1 year ago

0.1.158

1 year ago

0.1.157

1 year ago

0.1.159

1 year ago

0.1.154

1 year ago

0.1.153

1 year ago

0.1.156

1 year ago

0.1.155

1 year ago

0.1.152

1 year ago

0.1.169

1 year ago

0.1.168

1 year ago

0.1.165

1 year ago

0.1.164

1 year ago

0.1.167

1 year ago

0.1.166

1 year ago

0.1.161

1 year ago

0.1.160

1 year ago

0.1.163

1 year ago

0.1.162

1 year ago

0.1.170

1 year ago

0.1.179

1 year ago

0.1.176

1 year ago

0.1.175

1 year ago

0.1.178

1 year ago

0.1.177

1 year ago

0.1.172

1 year ago

0.1.171

1 year ago

0.1.174

1 year ago

0.1.173

1 year ago

0.1.181

1 year ago

0.1.180

1 year ago

0.1.187

1 year ago

0.1.186

1 year ago

0.1.189

1 year ago

0.1.188

1 year ago

0.1.183

1 year ago

0.1.182

1 year ago

0.1.185

1 year ago

0.1.184

1 year ago

0.1.151

1 year ago

0.1.150

1 year ago

0.1.149

1 year ago

0.1.148

1 year ago

0.1.147

1 year ago

0.1.146

1 year ago

0.1.145

1 year ago

0.1.144

2 years ago

0.1.143

2 years ago

0.1.142

2 years ago

0.1.141

2 years ago

0.1.140

2 years ago

0.1.139

2 years ago

0.1.136

2 years ago

0.1.135

2 years ago

0.1.138

2 years ago

0.1.137

2 years ago

0.1.134

2 years ago

0.1.132

2 years ago

0.1.133

2 years ago

0.1.131

2 years ago

0.1.130

2 years ago

0.1.129

2 years ago

0.1.128

2 years ago

0.1.127

2 years ago

0.1.126

2 years ago

0.1.125

2 years ago

0.1.124

2 years ago

0.1.123

2 years ago

0.1.122

2 years ago

0.1.121

2 years ago

0.1.120

2 years ago

0.1.119

2 years ago

0.1.118

2 years ago

0.1.117

2 years ago

0.1.116

2 years ago

0.1.115

2 years ago

0.1.114

2 years ago

0.1.113

2 years ago

0.1.112

2 years ago

0.1.110

2 years ago

0.1.111

2 years ago

0.1.109

2 years ago

0.1.107

2 years ago

0.1.108

2 years ago

0.1.52

2 years ago

0.1.53

2 years ago

0.1.54

2 years ago

0.1.55

2 years ago

0.1.56

2 years ago

0.1.57

2 years ago

0.1.58

2 years ago

0.1.59

2 years ago

0.1.50

2 years ago

0.1.51

2 years ago

0.1.49

2 years ago

0.1.45

2 years ago

0.1.46

2 years ago

0.1.47

2 years ago

0.1.48

2 years ago

0.1.96

2 years ago

0.1.97

2 years ago

0.1.98

2 years ago

0.1.99

2 years ago

0.1.90

2 years ago

0.1.91

2 years ago

0.1.92

2 years ago

0.1.93

2 years ago

0.1.94

2 years ago

0.1.95

2 years ago

0.1.85

2 years ago

0.1.86

2 years ago

0.1.87

2 years ago

0.1.88

2 years ago

0.1.89

2 years ago

0.1.80

2 years ago

0.1.81

2 years ago

0.1.82

2 years ago

0.1.83

2 years ago

0.1.84

2 years ago

0.1.74

2 years ago

0.1.75

2 years ago

0.1.76

2 years ago

0.1.77

2 years ago

0.1.78

2 years ago

0.1.79

2 years ago

0.1.70

2 years ago

0.1.71

2 years ago

0.1.72

2 years ago

0.1.73

2 years ago

0.1.63

2 years ago

0.1.64

2 years ago

0.1.65

2 years ago

0.1.66

2 years ago

0.1.67

2 years ago

0.1.68

2 years ago

0.1.69

2 years ago

0.1.60

2 years ago

0.1.61

2 years ago

0.1.62

2 years ago

0.1.106

2 years ago

0.1.103

2 years ago

0.1.102

2 years ago

0.1.105

2 years ago

0.1.104

2 years ago

0.1.101

2 years ago

0.1.100

2 years ago

0.1.41

2 years ago

0.1.42

2 years ago

0.1.43

2 years ago

0.1.44

2 years ago

0.1.40

2 years ago

0.1.30

2 years ago

0.1.31

2 years ago

0.1.32

2 years ago

0.1.33

2 years ago

0.1.34

2 years ago

0.1.35

2 years ago

0.1.36

2 years ago

0.1.37

2 years ago

0.1.27

2 years ago

0.1.28

2 years ago

0.1.29

2 years ago

0.1.20

2 years ago

0.1.21

2 years ago

0.1.22

2 years ago

0.1.23

2 years ago

0.1.24

2 years ago

0.1.25

2 years ago

0.1.26

2 years ago

0.1.38

2 years ago

0.1.39

2 years ago

0.1.18

2 years ago

0.1.19

2 years ago

0.1.10

3 years ago

0.1.11

3 years ago

0.1.12

3 years ago

0.1.13

3 years ago

0.1.14

3 years ago

0.1.15

3 years ago

0.1.16

3 years ago

0.1.17

3 years ago

0.1.8

3 years ago

0.1.7

3 years ago

0.1.9

3 years ago

0.1.5

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago

0.1.0

3 years ago

0.0.6

3 years ago

0.0.5

3 years ago

0.0.4

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago