cli/lito-manifest.schema.json at main · Lito-docs/cli · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Lito Template Manifest",
  "description": "Configuration schema for Lito documentation templates",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Template name"
    },
    "version": {
      "type": "string",
      "description": "Template version (semver)"
    },
    "framework": {
      "type": "string",
      "enum": ["astro", "react", "next", "vue", "nuxt", "svelte"],
      "description": "The framework this template uses"
    },
    "frameworkConfig": {
      "type": "object",
      "description": "Custom framework configuration overrides",
      "properties": {
        "contentDir": {
          "type": "string",
          "description": "Directory where documentation content is placed"
        },
        "publicDir": {
          "type": "string",
          "description": "Directory for static public assets"
        },
        "configFile": {
          "type": "string",
          "description": "Main framework config file name"
        },
        "layoutInjection": {
          "type": "boolean",
          "description": "Whether to inject layout frontmatter into markdown files"
        },
        "layoutPath": {
          "type": "string",
          "description": "Path to the markdown layout component"
        },
        "useMDX": {
          "type": "boolean",
          "description": "Whether the template uses MDX for markdown processing"
        }
      }
    },
    "commands": {
      "type": "object",
      "description": "Custom build/dev commands",
      "properties": {
        "dev": {
          "type": "array",
          "items": [
            { "type": "string", "description": "Binary name" },
            { "type": "array", "items": { "type": "string" }, "description": "Arguments" }
          ],
          "description": "Dev server command [binary, [args]]"
        },
        "build": {
          "type": "array",
          "items": [
            { "type": "string", "description": "Binary name" },
            { "type": "array", "items": { "type": "string" }, "description": "Arguments" }
          ],
          "description": "Build command [binary, [args]]"
        }
      }
    },
    "features": {
      "type": "object",
      "description": "Template feature flags",
      "properties": {
        "search": {
          "type": "boolean",
          "default": true,
          "description": "Whether template supports search"
        },
        "i18n": {
          "type": "boolean",
          "default": false,
          "description": "Whether template supports internationalization"
        },
        "versioning": {
          "type": "boolean",
          "default": false,
          "description": "Whether template supports doc versioning"
        },
        "darkMode": {
          "type": "boolean",
          "default": true,
          "description": "Whether template supports dark mode"
        },
        "apiDocs": {
          "type": "boolean",
          "default": false,
          "description": "Whether template supports OpenAPI documentation"
        }
      }
    },
    "requiredFiles": {
      "type": "array",
      "items": { "type": "string" },
      "description": "List of files required for this template to work"
    },
    "author": {
      "type": "string",
      "description": "Template author"
    },
    "repository": {
      "type": "string",
      "description": "Git repository URL"
    }
  },
  "required": ["framework"]
}