Skip to content

Commit

Permalink
Minor updates to theme.json schema pages (#50742)
Browse files Browse the repository at this point in the history
* Minor updates to theme.json schema pages
  • Loading branch information
mburridge authored May 19, 2023
1 parent bf80b72 commit a8da93f
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -594,13 +594,13 @@
"parent": "reference-guides"
},
{
"title": "Version 2 (living reference)",
"title": "Theme.json Version 2",
"slug": "theme-json-living",
"markdown_source": "../docs/reference-guides/theme-json-reference/theme-json-living.md",
"parent": "theme-json-reference"
},
{
"title": "Version 1 Reference",
"title": "Theme.json Version 1 Reference",
"slug": "theme-json-v1",
"markdown_source": "../docs/reference-guides/theme-json-reference/theme-json-v1.md",
"parent": "theme-json-reference"
Expand Down
23 changes: 17 additions & 6 deletions docs/reference-guides/theme-json-reference/theme-json-living.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# Version 2 (living reference)
# Theme.json Version 2

> This is the living specification for the **version 2** of theme.json. This version works with WordPress 5.9 or later, and the latest Gutenberg plugin.
> This is the living specification for **version 2** of `theme.json`. This version works with WordPress 5.9 or later, and the latest Gutenberg plugin.
>
> There're related documents you may be interested in: the [theme.json v1](/docs/reference-guides/theme-json-reference/theme-json-v1.md) specification and the [reference to migrate from theme.json v1 to v2](/docs/reference-guides/theme-json-reference/theme-json-migrations.md).
> There are some related documents that you may be interested in:
> - the [theme.json v1](/docs/reference-guides/theme-json-reference/theme-json-v1.md) specification, and
> - the [reference to migrate from theme.json v1 to v2](/docs/reference-guides/theme-json-reference/theme-json-migrations.md).
This reference guide lists the settings and style properties defined in the theme.json schema. See the [theme.json how to guide](/docs/how-to-guides/themes/theme-json.md) for examples and guide on how to use the theme.json file in your theme.
This reference guide lists the settings and style properties defined in the `theme.json` schema. See the [theme.json how to guide](/docs/how-to-guides/themes/theme-json.md) for examples and guidance on how to use the `theme.json` file in your theme.

## Schema

It can be difficult to remember the theme.json settings and properties while you develop, so a JSON scheme was created to help. The schema is available at https://schemas.wp.org/trunk/theme.json
Remembering the `theme.json` settings and properties while you develop can be difficult, so a [JSON schema](https://schemas.wp.org/trunk/theme.json) was created to help.

Code editors can pick up the schema and can provide helpful hints and suggestions such as tooltips, autocomplete, or schema validation in the editor. To use the schema in Visual Studio Code, add `$schema`: "https://schemas.wp.org/trunk/theme.json" to the beginning of your theme.json file together with a `version` corresponding to the version you wish to use, e.g.:

```
{
"$schema": "https://schemas.wp.org/trunk/theme.json",
"version": 2,
...
}
```

Code editors can pick up the schema and can provide help like tooltips, autocomplete, or schema validation in the editor. To use the schema in Visual Studio Code, add "$schema": "https://schemas.wp.org/trunk/theme.json" to the beginning of your theme.json file.

<!-- START TOKEN Autogenerated - DO NOT EDIT -->
## Settings
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Version 1 Reference
# Theme.json Version 1 Reference

Theme.json version 2 has been released, see the [theme.json migration guide](/docs/reference-guides/theme-json-reference/theme-json-migrations.md#migrating-from-v1-to-v2) for updating to the latest version.

Expand Down

0 comments on commit a8da93f

Please sign in to comment.