From b974208dd3ac4182d91ac480f6d5f9350c3774ba Mon Sep 17 00:00:00 2001 From: Jerel Miller Date: Mon, 22 Jun 2020 17:17:55 -0700 Subject: [PATCH] feat: Add documentation on the guide frontmatter --- STYLE_GUIDE.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 544f5c4a7..0109eb65f 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -274,18 +274,27 @@ The value that is assigned to the key slug is used in order to navigate to your - `title`: the title of the page - `template`: the Gatsby template used - `description`: the description of the page +- `promoteToHomepage` (optional): adds the guide as a tile to the homepage, making it + easier for users to discover +- `callout` (optional): config for the callout tile. Accepts 2 options: + - `title`: provide a title for the callout. Typically used to shorten the + title. The callout will fallback to the guide title if this is not provided. + - `description`: provide a description for the callout. The callout will + fallback to the guide description if this is not provided. ### GuideTemplate Frontmatter example -Be aware that all Frontmatter slugs are `required`. - ```md --- path: '/build-apps/add-time-picker-guide' duration: '20 min' title: 'Add the time picker to a sample application' template: 'GuideTemplate' -description: 'Example guide page' +description: 'Learn how to add a time picker to a sample application' +promoteToHomepage: true +callout: + title: Add a time picker + description: Add the time picker to a sample app to specify a time range in data --- ```