Files

112 lines
3.1 KiB
JSON

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "React Docs UI site config",
"type": "object",
"additionalProperties": true,
"properties": {
"breadcrumb": { "$ref": "#/$defs/breadcrumb" },
"reading": { "$ref": "#/$defs/reading" },
"sidebar": { "$ref": "#/$defs/sidebar" },
"toc": { "$ref": "#/$defs/toc" },
"footer": { "$ref": "#/$defs/footer" },
"sitemap": { "$ref": "#/$defs/sitemap" },
"feed": { "$ref": "#/$defs/feed" }
},
"$defs": {
"collapseControl": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"defaultCollapsed": { "type": "boolean" }
}
},
"sidebar": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"collapseControl": { "$ref": "#/$defs/collapseControl" }
}
},
"toc": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"collapseControl": { "$ref": "#/$defs/collapseControl" },
"maxLevel": { "type": "integer", "minimum": 1, "maximum": 6 },
"title": { "type": "string" }
}
},
"footer": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"copyright": { "type": "string" },
"beian": { "$ref": "#/$defs/footerLink" },
"policeBeian": { "$ref": "#/$defs/footerLink" },
"poweredBy": { "type": "boolean" }
}
},
"footerLink": {
"type": "object",
"additionalProperties": true,
"properties": {
"text": { "type": "string" },
"url": { "type": "string" }
}
},
"breadcrumb": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"showHome": { "type": "boolean" }
}
},
"reading": {
"type": "object",
"additionalProperties": true,
"properties": {
"showTime": { "type": "boolean" },
"showProgress": { "type": "boolean" },
"fullscreen": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" }
}
}
}
},
"sitemap": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"changefreq": {
"type": "string",
"enum": ["always", "hourly", "daily", "weekly", "monthly", "yearly", "never"]
},
"priority": { "type": "number", "minimum": 0, "maximum": 1 },
"exclude": {
"type": "array",
"items": { "type": "string" }
}
}
},
"feed": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"title": { "type": "string" },
"description": { "type": "string" },
"limit": { "type": "integer", "minimum": 1 }
}
}
}
}