From 2f03158fd94f3a412462bfde91b0d1ea5f866c59 Mon Sep 17 00:00:00 2001 From: Frank Li Date: Mon, 14 Aug 2017 16:25:48 -0700 Subject: [PATCH] Update Markdown Features doc with blog post headers --- docs/doc-markdown.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/doc-markdown.md b/docs/doc-markdown.md index 75daf6d858..a19543dd15 100644 --- a/docs/doc-markdown.md +++ b/docs/doc-markdown.md @@ -38,6 +38,29 @@ original_id: doc1 --- ``` +### Blog Posts + +Blog Posts use the following markdown header fields that are enclosed by a line `---` on either side: + +`title`: The title of this blog post. + +`author`: The author of this blog post. If this field is omitted, no author name will be shown. + +`authorURL`: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything. + +`authorFBID`: The author's Facebook id, used only to get the author's profile picture to display with the blog post. If this field is omitted, no author picture will be shown for the blog post. + +For example: + +```markdown +--- +title: My First Blog Post +author: Frank Li +authorURL: http://twitter.com/franchementli +authorFBID: 100002976521003 +--- +``` + ## Extra Features Docusaurus supports some extra features when writing documentation in markdown.