pandoc-templates/template.schema.json at main · Zettlr/pandoc-templates · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
{
  "title": "Pandoc Templates index.yml Schema",
  "description": "A schema to validate template metadata files against.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The full name of this template.",
      "type": "string"
    },
    "version": {
      "description": "The version number of this template. Must start at `1` and be incremented for each change.",
      "type": "number"
    },
    "changelog": {
      "description": "Describe changes to this template, one change per item",
      "type": "array",
      "items": { "type": "string" }
    },
    "description": {
      "description": "Describe the template. Markdown is supported. Be as extensive as necessary, but as concise as possible. Do not include setup instructions here (see property `instructions`).",
      "type": "string"
    },
    "instructions": {
      "description": "If the template requires some setup, explain this here. Also, describe any variables the template supports.",
      "type": "string"
    },
    "authors": {
      "type": "object",
      "description": "People or organizations who have contributed to this template.",
      "required": [
        "original",
        "templater"
      ],
      "properties": {
        "original": {
          "description": "Original author of the template itself (not the adaptation to Pandoc). Can be the same as `templater`.",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "email": {
                  "type": "string",
                  "format": "email"
                },
                "website": {
                  "type": "string",
                  "format": "uri"
                }
              },
              "required": [
                "name"
              ]
            }
          ]
        },
        "templater": {
          "description": "The person or institution who has adapted this template for usage with Pandoc (can be the same as `original`).",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "email": {
                  "type": "string",
                  "format": "email"
                },
                "website": {
                  "type": "string",
                  "format": "uri"
                }
              },
              "required": [
                "name"
              ]
            }
          ]
        },
        "contributors": {
          "description": "A list of contributors to this template, aside from `original` and `templater`.",
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "website": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "required": [
                  "name"
                ]
              }
            ]
          }
        }
      }
    },
    "copyright": {
      "description": "Use this to describe the template's copyright(s).",
      "type": "string"
    },
    "license": {
      "description": "Is the template licensed? If so, include a canonical form of the license name.",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "version",
    "description",
    "authors",
    "copyright"
  ]
}