Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 2.64 KB

add_new_blog.md

File metadata and controls

30 lines (26 loc) · 2.64 KB
Raw

Add a new blog post

  • Create a new markdown file for your blog under website/src/blogs.
    • Name of the markdown file should be the title of the blog converted to all small letters with hyphen(-) separation between the words. For example, If the title of the blog is: Title of the blog, then file name will be title-of-the-blog.md
    • All the images of the blog should be added to website/public/images/blog folder.
    • The feature blog image should be named as title-of-the-blog.png. Adding feature image to the blog is optional. If the blog does not have a feature image, add one more metadata not_has_feature_image: true. This will display the default feature image.
    • If you are a new author, add your photograph with file name as author-name.png to website/public/images/blog/authors. Make sure the name provided in the author section of the metadata of the blog matches with this filename
  • Add the following metadata at the top of the file:
---
title: Title of the blog
author: Author name
author_info: Author information
tags: All the tags with comma separation in between (Example: OpenEBS, LocalPV)
date: Date of publication in dd-mm-yyyy format
excerpt: Short description about the blog in about 200 hundred words. Words beyond 200 range will be clipped.
---
 
Blog content in the markdown format goes here…

Markdown Tips:

  • Bold text: To bold text, add two asterisks or underscores before and after a word or phrase. For example, **bold text**, __bold text__. Both of these texts will be rendered as bold text.
  • Italic text: To italicize text, add one asterisk or underscore before and after a word or phrase. For example, *italic text*, _italic text_. Both of these texts will be rendered as italic text
  • Bold and italic text: To emphasize text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase. For example, ***bold and italic text***, ___bold and italic text___. Both of these texts will be rendered as bold and italic text
  • Code block: The basic Markdown syntax allows you to create code blocks by indenting lines by four spaces or one tab. Or, you can use three backticks (```) before and after the code block
  • Figure caption: To display a figure caption, we use three asterisks before and after a word or phrase enclosed within round brackets. For example, (***Figure caption***). Please add figure caption on the line next to the image in the markdown without leaving any line space in between.

Reference for text formatting in markdown https://guides.github.com/features/mastering-markdown/