minimal/docs
3
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

fix newlines in schema descriptions

Browse Source
This commit is contained in:
James Brumond 2022-10-22 13:08:16 -07:00
parent 70e7c06eba
commit 209f163ec3
Signed by: james
GPG Key ID: 24BA25B8B303B023
2 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
schemas/color-theme/v1.json
View File

@ -5,7 +5,7 @@
"properties": {
"name": {
"type": "string",
"description": "The name of the color theme as it is displayed in web UI. Must match the file\nname of the theme file, e.g. a theme called \"example-theme\" should be located\nin a file called \"example-theme.theme.json\"\n"
"description": "The name of the color theme as it is displayed in web UI. Must match the file name of the theme file, e.g. a theme called \"example-theme\" should be located in a file called \"example-theme.theme.json\"\n"
},
"colors": {
"type": "object",
@ -13,23 +13,23 @@
"properties": {
"sun": {
"$ref": "#/definitions/css_color",
"description": "The color of the sun icon used to indicate that the light color theme is active. Must have\ngood contrast against bg_main\n"
"description": "The color of the sun icon used to indicate that the light color theme is active. Must have good contrast against bg_main\n"
},
"moon": {
"$ref": "#/definitions/css_color",
"description": "The color of the moon icon used to indicate that the dark color theme is active. Must have\ngood contrast against bg_main\n"
"description": "The color of the moon icon used to indicate that the dark color theme is active. Must have good contrast against bg_main\n"
},
"bg_main": {
"$ref": "#/definitions/css_color",
"description": "The primary background color applied to the page as a whole. Must have good contrast against\nthe main copy text colors text_heading, text_body, text_light, text_link, text_link_active,\nand text_link_visited\n"
"description": "The primary background color applied to the page as a whole. Must have good contrast against the main copy text colors text_heading, text_body, text_light, text_link, text_link_active, and text_link_visited\n"
},
"bg_light": {
"$ref": "#/definitions/css_color",
"description": "A lighter background color applied to content panels; Should have a relatively low contrast against\nthe bg_main color, providing only a light accent. Must have good contrast against the main copy text\ncolors text_heading, text_body, text_light, text_link, text_link_active, and text_link_visited\n"
"description": "A lighter background color applied to content panels; Should have a relatively low contrast against the bg_main color, providing only a light accent. Must have good contrast against the main copy text colors text_heading, text_body, text_light, text_link, text_link_active, and text_link_visited\n"
},
"bg_heavy": {
"$ref": "#/definitions/css_color",
"description": "A heavier background color applied to content panels; Should have a relatively higher contrast against\nthe bg_main color, directing attention to what is \"important\" or \"primary\" content inside of it. Must\nhave good contrast against the main copy text colors text_heading, text_body, text_light, text_link,\ntext_link_active, and text_link_visited\n"
"description": "A heavier background color applied to content panels; Should have a relatively higher contrast against the bg_main color, directing attention to what is \"important\" or \"primary\" content inside of it. Must have good contrast against the main copy text colors text_heading, text_body, text_light, text_link, text_link_active, and text_link_visited\n"
},
"bg_popup_mask": {
"$ref": "#/definitions/css_color"
@ -62,11 +62,11 @@
},
"text_highlight": {
"$ref": "#/definitions/css_color",
"description": "The color of text highlighted using the <mark>text</mark> tag (or by using ==text==\nin markdown)\n"
"description": "The color of text highlighted using the <mark>text</mark> tag (or by using ==text== in markdown)\n"
},
"bg_text_highlight": {
"$ref": "#/definitions/css_color",
"description": "The background color of text highlighted using the <mark>text</mark> tag (or by using\n==text== in markdown)\n"
"description": "The background color of text highlighted using the <mark>text</mark> tag (or by using ==text== in markdown)\n"
},
"text_selection": {
"$ref": "#/definitions/css_color",
@ -78,11 +78,11 @@
},
"bg_button_primary": {
"$ref": "#/definitions/css_color",
"description": "The background color of \"primary\" buttons (typically major, positive actions, like \"save\"\nor \"publish\")\n"
"description": "The background color of \"primary\" buttons (typically major, positive actions, like \"save\" or \"publish\")\n"
},
"bg_button_primary_hover": {
"$ref": "#/definitions/css_color",
"description": "The background color of \"primary\" buttons (typically major, positive actions, like \"save\"\nor \"publish\") while the user is hovering over them\n"
"description": "The background color of \"primary\" buttons (typically major, positive actions, like \"save\" or \"publish\") while the user is hovering over them\n"
},
"text_button_primary": {
"$ref": "#/definitions/css_color",
@ -90,15 +90,15 @@
},
"bg_button_secondary": {
"$ref": "#/definitions/css_color",
"description": "The background color of \"secondary\" buttons (typically safe, unimpactful, or backward moving\nactions, like \"cancel\" or \"preview\")\n"
"description": "The background color of \"secondary\" buttons (typically safe, unimpactful, or backward moving actions, like \"cancel\" or \"preview\")\n"
},
"bg_button_secondary_hover": {
"$ref": "#/definitions/css_color",
"description": "The background color of \"secondary\" buttons (typically safe, unimpactful, or backward moving\nactions, like \"cancel\" or \"preview\") while the user is hovering over them\n"
"description": "The background color of \"secondary\" buttons (typically safe, unimpactful, or backward moving actions, like \"cancel\" or \"preview\") while the user is hovering over them\n"
},
"text_button_secondary": {
"$ref": "#/definitions/css_color",
"description": "The text color of \"secondary\" buttons (typically safe, unimpactful, or backward moving actions,\nlike \"cancel\" or \"preview\")\n"
"description": "The text color of \"secondary\" buttons (typically safe, unimpactful, or backward moving actions, like \"cancel\" or \"preview\")\n"
},
"bg_error_box": {
"$ref": "#/definitions/css_color"

28
schemas/color-theme/v1.yaml
View File

@ -4,7 +4,7 @@ type: object
properties:
name:
type: string
description: |
description: >
The name of the color theme as it is displayed in web UI. Must match the file
name of the theme file, e.g. a theme called "example-theme" should be located
in a file called "example-theme.theme.json"
@ -16,31 +16,31 @@ properties:
# Theme Picker Icon Colors
sun:
$ref: "#/definitions/css_color"
description: |
description: >
The color of the sun icon used to indicate that the light color theme is active. Must have
good contrast against bg_main
moon:
$ref: "#/definitions/css_color"
description: |
description: >
The color of the moon icon used to indicate that the dark color theme is active. Must have
good contrast against bg_main
# Content Background Colors
bg_main:
$ref: "#/definitions/css_color"
description: |
description: >
The primary background color applied to the page as a whole. Must have good contrast against
the main copy text colors text_heading, text_body, text_light, text_link, text_link_active,
and text_link_visited
bg_light:
$ref: "#/definitions/css_color"
description: |
description: >
A lighter background color applied to content panels; Should have a relatively low contrast against
the bg_main color, providing only a light accent. Must have good contrast against the main copy text
colors text_heading, text_body, text_light, text_link, text_link_active, and text_link_visited
bg_heavy:
$ref: "#/definitions/css_color"
description: |
description: >
A heavier background color applied to content panels; Should have a relatively higher contrast against
the bg_main color, directing attention to what is "important" or "primary" content inside of it. Must
have good contrast against the main copy text colors text_heading, text_body, text_light, text_link,
@ -77,12 +77,12 @@ properties:
# Text Highlighted with <mark>
text_highlight:
$ref: "#/definitions/css_color"
description: |
description: >
The color of text highlighted using the <mark>text</mark> tag (or by using ==text==
in markdown)
bg_text_highlight:
$ref: "#/definitions/css_color"
description: |
description: >
The background color of text highlighted using the <mark>text</mark> tag (or by using
==text== in markdown)
@ -97,31 +97,31 @@ properties:
# Buttons
bg_button_primary:
$ref: "#/definitions/css_color"
description: |
description: >
The background color of "primary" buttons (typically major, positive actions, like "save"
or "publish")
bg_button_primary_hover:
$ref: "#/definitions/css_color"
description: |
description: >
The background color of "primary" buttons (typically major, positive actions, like "save"
or "publish") while the user is hovering over them
text_button_primary:
$ref: "#/definitions/css_color"
description: |
description: >
The text color of "primary" buttons (typically major, positive actions, like "save" or "publish")
bg_button_secondary:
$ref: "#/definitions/css_color"
description: |
description: >
The background color of "secondary" buttons (typically safe, unimpactful, or backward moving
actions, like "cancel" or "preview")
bg_button_secondary_hover:
$ref: "#/definitions/css_color"
description: |
description: >
The background color of "secondary" buttons (typically safe, unimpactful, or backward moving
actions, like "cancel" or "preview") while the user is hovering over them
text_button_secondary:
$ref: "#/definitions/css_color"
description: |
description: >
The text color of "secondary" buttons (typically safe, unimpactful, or backward moving actions,
like "cancel" or "preview")