Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updated contribution guidelines with info about list_title frontmatter

pull/105/head
Scott Anderson 2019-03-25 10:25:01 -06:00
parent 505f24c60a
commit b093d482e0
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -53,6 +53,7 @@ Frontmatter populates variables in page templates and the site's navigation menu
```yaml ```yaml
title: # Title of the page used in the page's h1 title: # Title of the page used in the page's h1
seotitle: # Page title used in the html <head> title and used in search engine results seotitle: # Page title used in the html <head> title and used in search engine results
list_title: # Title used in article lists generated using the {{< children >}} shortcode
description: # Page description displayed in search engine results description: # Page description displayed in search engine results
menu: menu:
v2_0: v2_0:
@ -77,6 +78,10 @@ It shouldn't be overly long, but should set the context for users coming from ou
The `seotitle` frontmatter populates each page's HTML `title` attribute. The `seotitle` frontmatter populates each page's HTML `title` attribute.
Search engines use this in search results (not the page's h1) and therefore it should be keyword optimized. Search engines use this in search results (not the page's h1) and therefore it should be keyword optimized.
##### `list_title`
The `list_title` frontmatter determines an article title when in a list generated
by the [`{{< children >}}` shortcode](#generate-a-list-of-children-articles).
##### `menu > name` ##### `menu > name`
The `name` attribute under the `menu` frontmatter determines the text used in each page's link in the site navigation. The `name` attribute under the `menu` frontmatter determines the text used in each page's link in the site navigation.
It should be short and assume the context of its parent if it has one. It should be short and assume the context of its parent if it has one.