display templateParts info in a table

WordPress · Mar 1, 2023 · 1fed2df · 1fed2df
1 parent 4247c51
commit 1fed2df
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/bin/api-docs/gen-theme-reference.js b/bin/api-docs/gen-theme-reference.js
@@ -227,12 +227,12 @@ autogen += '\n\n';
 // templateParts
 const templateParts = themejson.properties.templateParts.items.properties;
 autogen += '## templateParts' + '\n\n';
-autogen += themejson.properties.templateParts.description + '\n';
+autogen += themejson.properties.templateParts.description + '\n\n';
 autogen += 'Type: `' + themejson.properties.templateParts.items.type + '`.\n\n';
+autogen += '| Property | Description | Type |\n';
+autogen += '| ---      | ---         | ---  |\n';
 keys( templateParts ).forEach( ( key ) => {
-	autogen += '`' + key + '`: ';
-	autogen += templateParts[ key ].description + ' ';
-	autogen += 'Type: `' + templateParts[ key ].type + '`.\n';
+	autogen += `| ${ key } | ${ templateParts[ key ].description } | ${ templateParts[ key ].type } |\n`;
 } );
 autogen += '\n\n';
 

diff --git a/docs/reference-guides/theme-json-reference/theme-json-living.md b/docs/reference-guides/theme-json-reference/theme-json-living.md
@@ -261,11 +261,14 @@ Type: `object`.
 ## templateParts
 
 Additional metadata for template parts defined in the parts folder.
+
 Type: `object`.
 
-`name`: Filename, without extension, of the template in the parts folder. Type: `string`.
-`title`: Title of the template, translatable. Type: `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. Type: `string`.
+| 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