Update theme.json reference docs to include more sections (#48250)

* Update theme.json reference docs to include more sections --------- Co-authored-by: Ari Stathopoulos <[email protected]>
WordPress · Apr 13, 2023 · 724f577 · 724f577 · github-actions · Apr 13, 2023
1 parent 595d774
commit 724f577
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 0 deletions.
diff --git a/bin/api-docs/gen-theme-reference.js b/bin/api-docs/gen-theme-reference.js
@@ -211,6 +211,35 @@ styleSections.forEach( ( section ) => {
 	autogen += getSectionMarkup( section, styles[ section ], 'styles' );
 } );
 
+const templateTableGeneration = ( themeJson, context ) => {
+	let content = '';
+	content += '## ' + context + '\n\n';
+	content += themeJson.properties[ context ].description + '\n\n';
+	content +=
+		'Type: `' + themeJson.properties[ context ].items.type + '`.\n\n';
+	content += '| Property | Description | Type |\n';
+	content += '| ---      | ---         | ---  |\n';
+	keys( themeJson.properties[ context ].items.properties ).forEach(
+		( key ) => {
+			content += `| ${ key } | ${ themeJson.properties[ context ].items.properties[ key ].description } | ${ themeJson.properties[ context ].items.properties[ key ].type } |\n`;
+		}
+	);
+	content += '\n\n';
+
+	return content;
+};
+
+// customTemplates
+autogen += templateTableGeneration( themejson, 'customTemplates' );
+
+// templateParts
+autogen += templateTableGeneration( themejson, 'templateParts' );
+
+// Patterns
+autogen += '## Patterns' + '\n\n';
+autogen += themejson.properties.patterns.description + '\n';
+autogen += 'Type: `' + themejson.properties.patterns.type + '`.\n\n';
+
 // Read existing file to wrap auto generated content.
 let docsContent = fs.readFileSync( THEME_JSON_REF_DOC, {
 	encoding: 'utf8',

diff --git a/docs/reference-guides/theme-json-reference/theme-json-living.md b/docs/reference-guides/theme-json-reference/theme-json-living.md
@@ -268,5 +268,36 @@ Sets custom CSS to apply styling not covered by other theme.json properties.
 
 
 ---
+## customTemplates
+
+Additional metadata for custom templates defined in the templates folder.
+
+Type: `object`.
+
+| Property | Description | Type |
+| ---      | ---         | ---  |
+| name | Filename, without extension, of the template in the templates folder. | string |
+| title | Title of the template, translatable. | string |
+| postTypes | List of post types that can use this custom template. | array |
+
+
+## templateParts
+
+Additional metadata for template parts defined in the parts folder.
+
+Type: `object`.
+
+| Property | Description | Type |
+| ---      | ---         | ---  |
+| name | Filename, without extension, of the template in the parts folder. | string |
+| title | Title of the template, translatable. | string |
+| area | The area the template part is used for. Block variations for `header` and `footer` values exist and will be used when the area is set to one of those. | string |
+
+
+## Patterns
+
+An array of pattern slugs to be registered from the Pattern Directory.
+Type: `array`.
+
 
 <!-- END TOKEN Autogenerated - DO NOT EDIT -->