From f97bcdf70e0a01332122b95f3d03fcd4630a9909 Mon Sep 17 00:00:00 2001 From: mrugesh mohapatra <1884376+raisedadead@users.noreply.github.com> Date: Thu, 22 Nov 2018 00:51:43 +0530 Subject: [PATCH] docs: update guide front matter --- docs/style-guide-for-guide-articles.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/style-guide-for-guide-articles.md b/docs/style-guide-for-guide-articles.md index f57215e5d6..edc50cf858 100644 --- a/docs/style-guide-for-guide-articles.md +++ b/docs/style-guide-for-guide-articles.md @@ -12,6 +12,13 @@ Folder name is used in the URL, so only use dashes (-), numbers (0-9), and lower However, you can include special characters in the article title. +The titles use a speacial YAML front matter syntax block as shown below. These contain the information required by the build tools to create webpages for the guide articles. + +These are the specific front matter requirements: +1. The front matter block should be on the first line of the file. +2. The front matter block should not have whitespaces before and after the lines. +3. Each key value pair is separated by one space only + Here are some examples of properly named titles: > [`src/pages/html/tables/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/src/pages/html/tables/index.md)