Ghost · Schema

Settings

Global publication settings including identity, branding, navigation, and configuration.

PublishingNewslettersMembershipsContentOpen Source

Properties

Name Type Description
title string Publication title
description string Publication description
logo string Publication logo URL
icon string Publication favicon URL
accent_color string Publication accent color
cover_image string Publication cover image URL
facebook string Facebook page username
twitter string Twitter account handle
lang string Publication language code
timezone string Publication timezone
codeinjection_head string Global code injection in the head
codeinjection_foot string Global code injection in the foot
navigation array Primary navigation items
secondary_navigation array Secondary navigation items
meta_title string Global SEO meta title
meta_description string Global SEO meta description
og_image string Default Open Graph image
og_title string Default Open Graph title
og_description string Default Open Graph description
twitter_image string Default Twitter card image
twitter_title string Default Twitter card title
twitter_description string Default Twitter card description
members_support_address string Support email address for members
url string Site URL
View JSON Schema on GitHub

JSON Schema

ghost-settings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Settings",
  "title": "Settings",
  "type": "object",
  "description": "Global publication settings including identity, branding, navigation, and configuration.",
  "properties": {
    "title": {
      "type": "string",
      "description": "Publication title"
    },
    "description": {
      "type": "string",
      "description": "Publication description"
    },
    "logo": {
      "type": "string",
      "format": "uri",
      "description": "Publication logo URL",
      "nullable": true
    },
    "icon": {
      "type": "string",
      "format": "uri",
      "description": "Publication favicon URL",
      "nullable": true
    },
    "accent_color": {
      "type": "string",
      "description": "Publication accent color",
      "nullable": true,
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "cover_image": {
      "type": "string",
      "format": "uri",
      "description": "Publication cover image URL",
      "nullable": true
    },
    "facebook": {
      "type": "string",
      "description": "Facebook page username",
      "nullable": true
    },
    "twitter": {
      "type": "string",
      "description": "Twitter account handle",
      "nullable": true
    },
    "lang": {
      "type": "string",
      "description": "Publication language code"
    },
    "timezone": {
      "type": "string",
      "description": "Publication timezone"
    },
    "codeinjection_head": {
      "type": "string",
      "description": "Global code injection in the head",
      "nullable": true
    },
    "codeinjection_foot": {
      "type": "string",
      "description": "Global code injection in the foot",
      "nullable": true
    },
    "navigation": {
      "type": "array",
      "description": "Primary navigation items",
      "items": {
        "$ref": "#/components/schemas/NavigationItem"
      }
    },
    "secondary_navigation": {
      "type": "array",
      "description": "Secondary navigation items",
      "items": {
        "$ref": "#/components/schemas/NavigationItem"
      }
    },
    "meta_title": {
      "type": "string",
      "description": "Global SEO meta title",
      "nullable": true
    },
    "meta_description": {
      "type": "string",
      "description": "Global SEO meta description",
      "nullable": true
    },
    "og_image": {
      "type": "string",
      "format": "uri",
      "description": "Default Open Graph image",
      "nullable": true
    },
    "og_title": {
      "type": "string",
      "description": "Default Open Graph title",
      "nullable": true
    },
    "og_description": {
      "type": "string",
      "description": "Default Open Graph description",
      "nullable": true
    },
    "twitter_image": {
      "type": "string",
      "format": "uri",
      "description": "Default Twitter card image",
      "nullable": true
    },
    "twitter_title": {
      "type": "string",
      "description": "Default Twitter card title",
      "nullable": true
    },
    "twitter_description": {
      "type": "string",
      "description": "Default Twitter card description",
      "nullable": true
    },
    "members_support_address": {
      "type": "string",
      "format": "email",
      "description": "Support email address for members"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Site URL"
    }
  }
}