You can write a blog in any editor you like, no restrictions.

Where to place the blog

Every blog needs a markdown file at the least. This markdown file should be named as index.md and must be placed under a folder which it self is under content folder. This folder represents a blog.

Example

| ...
|-- content/
	|-- monsters
		|-- where-is-cthulu
			|-- index.md
			|-- cover.png

This example is for the blog example.kriti.blog/monsters/where-is-cthulu. Content for this blog is available inside the index.md and cover.png represents the cover image of the blog.

The Cover Image

Blog can optionally have a cover image. This image pops up when listing the blog or when blog is opened up it is shown front and center. To add a cover image to a blog just add an image file (png, jpeg, webp) to the blog folder and rename it to cover.

The index.md file

This is the text content of every blog. It follows the markdown guidelines as presented here. This file is made up of 2 sections.

Frontmatter

These are optional but Good To Have properties.

Example

---
title: Blog title, short & sweet
description: Blog description, used as meta description tag for the page, useful for SEO
publishDate: YYYY-MM-DD
author: User name
summary: Optional, summary displayed on the home page for every blog
---

Most of the properties are self describing. title & description are used in <meta> tags for the generated web page which are useful for indexing and SEO. summary is different from description it is the blog summary shown only on the home page under every blog title, a sort of post preview. summary will be generated from the contents if not provided.

Frontmatter must be the first section of every index.md file and should start on line 1 and end with 3 hyphens --- on a new line.

Markdown

Actual blog content. It follows the markdown guidelines as presented here. This document won’t suggest what to write in the content, it is up to the user.

FAQs

  1. Can I have 2 index.md files? No
  2. Can I have 0 index.md files? No
  3. Is cover required? Optional
  4. Is frontmatter required? Recommended for SEO but optional
  5. Is markdown content required? No, but then why even write a blog at this point
  6. How do I add 2 blogs under same URL? Create a parent folder having common URL name and then create 2 folders under the parent for each blog. Example
| ...
|-- content/
	|-- parent
		|-- blog1
			|-- index.md
		|-- blog2
			|-- index.md

These would be available at example.kriti.blog/parent/blog1 and example.kriti.blog/parent/blog2.

  1. I want parent to also be a blog We are working on the feature, thank you for your patience.