microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
scripts/linting/schemas/docs-frontmatter.schema.json
47lines · modecode
| 1 | { |
| 2 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 3 | "$id": "https://github.com/microsoft/hve-core/schemas/docs-frontmatter.schema.json", |
| 4 | "title": "Documentation File Frontmatter Schema", |
| 5 | "description": "Frontmatter schema for files in the docs directory", |
| 6 | "allOf": [ |
| 7 | { |
| 8 | "$ref": "base-frontmatter.schema.json" |
| 9 | } |
| 10 | ], |
| 11 | "type": "object", |
| 12 | "required": ["title", "description"], |
| 13 | "properties": { |
| 14 | "title": { |
| 15 | "type": "string", |
| 16 | "minLength": 1 |
| 17 | }, |
| 18 | "description": { |
| 19 | "type": "string", |
| 20 | "minLength": 1 |
| 21 | }, |
| 22 | "author": { |
| 23 | "type": "string", |
| 24 | "description": "Recommended: Author or team name" |
| 25 | }, |
| 26 | "ms.date": { |
| 27 | "$ref": "base-frontmatter.schema.json#/definitions/iso8601Date", |
| 28 | "description": "Recommended: Last modified date" |
| 29 | }, |
| 30 | "ms.topic": { |
| 31 | "type": "string", |
| 32 | "enum": ["overview", "concept", "tutorial", "reference", "how-to", "troubleshooting", "architecture"], |
| 33 | "description": "Recommended: Documentation topic type" |
| 34 | }, |
| 35 | "keywords": { |
| 36 | "$ref": "base-frontmatter.schema.json#/definitions/keywordsArray" |
| 37 | }, |
| 38 | "estimated_reading_time": { |
| 39 | "$ref": "base-frontmatter.schema.json#/definitions/positiveInteger" |
| 40 | }, |
| 41 | "ms.custom": { |
| 42 | "type": "object", |
| 43 | "description": "Custom Microsoft metadata" |
| 44 | } |
| 45 | }, |
| 46 | "additionalProperties": true |
| 47 | } |