Skip to content

Commit

Permalink
Updates metadata docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmerfield committed Nov 21, 2024
1 parent 29dadb1 commit 232faae
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions app/views/how/metadata.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,21 +81,21 @@ <h2>Metadata reference</h2>
</tr>

<tr>
<td>Title</td>
<td><h2>Title</h2></td>
<td>By default is the text of the first heading in the post or the file’s name.
You should generally only set this metadata when you want to show a different title for the post or page in your site's menu or on your archives page. It is best practice to either rename the source file or use a heading in the post itself.
<pre class="metadata-example"><code>Title: Your title here</code></pre>
</td>
</tr>

<tr>
<td>Comments</td>
<td><h2>Comments</h2></td>
<td>Determines whether comments are enabled on the post or the page. Can be <code>Yes</code> or <code>No</code>. By default is <code>Yes</code> for posts and <code>No</code> for pages. Has no effect if comments are disabled in the site settings.
<pre class="metadata-example"><code>Comments: No</code></pre>
</td>
</tr>
<tr>
<td>Summary</td>
<td><h2>Summary</h2></td>
<td>By default is the text of the first sentence of the first paragraph in the file. Some templates make use of this metadata, others do not.
<pre class="metadata-example"><code>Summary: A brief summary of the post</code></pre>

Expand All @@ -110,14 +110,14 @@ <h2>Metadata reference</h2>
[[={{ }}=]]
</tr>
<tr>
<td>Search</td>
<td><h2>Search</h2></td>
<td>Determines whether a post is included in your site’s search results. Can be <code>Yes</code> or <code>No</code>. By default is <code>Yes</code> for posts and <code>No</code> for pages.
<pre class="metadata-example"><code>Search: No</code></pre>
</td>
</tr>
</tr>
<tr>
<td>Tags</td>
<td><h2>Tags</h2></td>
<td>Use tags to connect posts with similar subjects. Specify tags in the file’s metadata or in its <a href="#set-tags-using-your-folder">path</a>. Here’s an example post with two tags in its metadata:</p>
<pre class="metadata-example"><code>Tags: Getting started, Documentation</code></pre>

Expand Down Expand Up @@ -156,23 +156,23 @@ <h2>Metadata reference</h2>
</td>
</tr>
<tr>
<td>Thumbnail</td>
<td><h2>Thumbnail</h2></td>
<td>By default is the first image or video thumbnail in the post with both a height and width greater than 64 pixels. You can specify a URL, or a path to an image in your site’s folder.</td>
</tr>
<tr>
<td>Draft</td>
<td><h2>Draft</h2></td>
<td>Determines whether a file becomes a draft. Can be ’Yes’ or ’No’. By default is ’No’ unless the file is inside a folder called ’Drafts’.</td>
</tr>
<tr>
<td>Page</td>
<td><h2>Page</h2></td>
<td>Determines whether a file becomes a page or a post. Can be ’Yes’ or ’No’. By default is ’No’ unless the file is inside a folder called ’Pages’.</td>
</tr>
<tr>
<td>Menu</td>
<td><h2>Menu</h2></td>
<td>Determines whether a file appears on your site’s menu. Can be ’Yes’ or ’No’. By default is ’Yes’ for pages and ’No’ for posts.</td>
</tr>
<tr>
<td>Slug</td>
<td><h2>Slug</h2></td>
<td>Used to generate the URL for a post or page as part of your site's <a href="/how/configure/link-format">link format</a> setting.

</td>
Expand Down

0 comments on commit 232faae

Please sign in to comment.