Instructions to post a blog

Prerequisites:

  1. A GitHub Account.
  2. Check that you are a member of KMIT-Anubhav GitHub organisation. If not contact admins of Anubhav.

Procedure:

Step-1:

Go to https://kmit-anubhav.github.io and click on Create New Post.
Log in to your GitHub account that’s associated with KMIT-Anubhav organisation if asked.

Step-2:

You will now be shown up an editor page.
Name the file as per the format YYYY-MM-DD-title.md.

  • Title should not contain any spaces or hyphens -, use underscores _ instead.
  • .md file extension is mandatory.

Step-3:

The file body must start with details block

---
title: "My Title"
date: YYYY-MM-DD
---
  • You can optionally add author: key to the details block to display your username on the blog.
    The details block should now look like…
    ---
    title: "My Title"
    date: YYYY-MM-DD
    author: "My GitHub username"
    ---
    

    Note that this guide doesn’t mention author key anywhere further in this guide.

Basic formatting syntax is mentioned in the below image.
Edit

Refer here for more formatting syntaxes.

You can preview the blog by clicking on Preview button.
Preview

Step-4:

Save the file by clicking Propose/Commit new file button at the bottom of the page.

Step-5:

You will now see an page that says Comparing Changes. Click The Green button saying Create Pull Request.
Change the name of Pull Request to the Title of your blog and click Create Pull Request.
Your file will now be reviewed and your blog will be posted soon.
Check https://kmit-anubhav.github.io to see if your blog is published. Note that this will take some time.

Instructions to enable using comments on blogs:

Prerequisites:

  • A GitHub Account.

Procedure:

  • Go to the blog post on which you want to commit and click on Sign in with GitHub button.

Comment

  • You will see a page that will request you to give permissions to Giscus via your github account. Accept it and you are ready to go.

Giscus