cheatsheets.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://json.schemastore.org/cheatsheets.json",
  "$comment": "https://github.com/cheat/cheat",
  "additionalProperties": false,
  "properties": {
    "editor": {
      "$ref": "https://json.schemastore.org/base.json#/definitions/editor",
      "description": "An editor to modify cheatsheets\nhttps://github.com/cheat/cheat#cheatpaths"
    },
    "colorize": {
      "description": "Whether cheatsheets should be colorized\nhttps://github.com/cheat/cheat#cheatpaths",
      "type": "boolean",
      "default": false
    },
    "style": {
      "description": "A color schema applied for cheatsheets\nhttps://github.com/cheat/cheat#cheatpaths",
      "type": "string",
      "enum": [
        "abap",
        "algol",
        "algol_nu",
        "api",
        "arduino",
        "autumn",
        "average",
        "base16-snazzy",
        "borland",
        "bw",
        "catppuccin-frappe",
        "catppuccin-latte",
        "catppuccin-macchiato",
        "catppuccin-mocha",
        "colorful",
        "compat",
        "doom-one",
        "doom-one2",
        "dracula",
        "emacs",
        "friendly",
        "fruity",
        "github",
        "github-dark",
        "gruvbox",
        "gruvbox-light",
        "hr_high_contrast",
        "hrdark",
        "igor",
        "lovelace",
        "manni",
        "modus-operandi",
        "modus-vivendi",
        "monokai",
        "monokailight",
        "murphy",
        "native",
        "nord",
        "onedark",
        "onesenterprise",
        "paraiso-dark",
        "paraiso-light",
        "pastie",
        "perldoc",
        "pygments",
        "rainbow_dash",
        "rose-pine",
        "rose-pine-dawn",
        "rose-pine-moon",
        "rrt",
        "solarized-dark",
        "solarized-dark256",
        "solarized-light",
        "swapoff",
        "tango",
        "trac",
        "vim",
        "vs",
        "vulcan",
        "witchhazel",
        "xcode",
        "xcode-dark"
      ]
    },
    "formatter": {
      "description": "A formatter to format cheatsheets\nhttps://github.com/cheat/cheat#cheatpaths",
      "type": "string",
      "enum": ["terminal", "terminal256", "terminal16m"]
    },
    "pager": {
      "description": "A pager to read long cheatsheets\nhttps://github.com/cheat/cheat#cheatpaths",
      "type": "string",
      "oneOf": [
        {
          "enum": ["less", "more"]
        },
        {}
      ]
    },
    "cheatpaths": {
      "description": "Cheatpaths\nhttps://github.com/cheat/cheat#cheatpaths",
      "type": "array",
      "items": {
        "title": "cheatpath",
        "description": "A cheatpath\nhttps://github.com/cheat/cheat#cheatpaths",
        "type": "object",
        "properties": {
          "name": {
            "description": "A cheatpath name\nhttps://github.com/cheat/cheat#cheatpaths",
            "type": "string",
            "minLength": 1
          },
          "path": {
            "$ref": "https://json.schemastore.org/base.json#/definitions/path",
            "description": "A cheatpath path\nhttps://github.com/cheat/cheat#cheatpaths"
          },
          "tags": {
            "description": "Cheatpath tags\nhttps://github.com/cheat/cheat#cheatpaths",
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string",
              "minLength": 1
            }
          },
          "readonly": {
            "description": "Whether allow creating cheatsheets in a cheatpath\nhttps://github.com/cheat/cheat#cheatpaths",
            "type": "boolean",
            "default": false
          }
        },
        "additionalProperties": false
      }
    }
  },
  "title": "A cheatsheet config schema",
  "type": "object"
}