archival 0.18.0

The simplest CMS in existence
Documentation 
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

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://archival.dev/schemas/archival_objects.schema.json",
  "title": "Archival object definitions",
  "description": "The object definitions for an archival site, read from archival_objects.toml (or the file named by object_file in archival.toml).",
  "type": "object",
  "propertyNames": {
    "$ref": "#/definitions/objectName"
  },
  "additionalProperties": {
    "$ref": "#/definitions/objectDefinition"
  },
  "definitions": {
    "objectName": {
      "description": "objects may not be named with one of archival's reserved names",
      "not": {
        "enum": [
          "object_name",
          "order",
          "objects",
          "page",
          "page_name",
          "template"
        ]
      }
    },
    "fieldName": {
      "description": "fields may not use archival's reserved names. `template` is the exception: it is reserved as a field, but is how an object names the page it renders with.",
      "not": {
        "enum": ["object_name", "order", "objects", "page", "page_name"]
      }
    },
    "objectDefinition": {
      "type": "object",
      "propertyNames": {
        "$ref": "#/definitions/fieldName"
      },
      "properties": {
        "template": {
          "description": "the name of a page in your pages dir that each of this object's instances is rendered with",
          "type": "string"
        }
      },
      "additionalProperties": {
        "$ref": "#/definitions/field"
      }
    },
    "field": {
      "anyOf": [
        {
          "$ref": "#/definitions/fieldType"
        },
        {
          "description": "a string enum - the field may be any one of these values",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "description": "a oneof - the field holds a value of exactly one of these named types",
          "type": "array",
          "items": {
            "$ref": "#/definitions/oneofOption"
          }
        },
        {
          "$ref": "#/definitions/objectDefinition"
        }
      ]
    },
    "oneofOption": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "type"],
      "properties": {
        "name": {
          "description": "the name this option is referred to by in templates and the editor",
          "type": "string"
        },
        "type": {
          "$ref": "#/definitions/fieldType"
        }
      }
    },
    "fieldType": {
      "description": "an archival type, or the name of a custom editor type defined in archival.toml",
      "anyOf": [
        {
          "$ref": "#/definitions/archivalFieldType"
        },
        {
          "type": "string"
        }
      ]
    },
    "archivalFieldType": {
      "type": "string",
      "enum": [
        "string",
        "number",
        "boolean",
        "date",
        "markdown",
        "image",
        "video",
        "audio",
        "upload",
        "meta",
        "secret"
      ]
    }
  }
}