5 Minutes Setup

No account needed.
Just GitHub + Markdown

The simplest way to blog. Your content, your repo, your rules.

01
01

Create a blog folder

In any public GitHub repo, create a folder called blog

your-repo/
  blog/    <- create this
  README.md
02
02

Add your first post

Create a .md file inside the blog folder. The filename becomes the URL.

blog/hello-world.md -> /user/repo/hello-world
03
03

Add frontmatter

The stuff between the --- lines is called frontmatter. It is metadata about your post.

---
title: Hello World
date: 2024-01-01
description: My first post
---

Your content here...
04
04

Visit your blog

That is it! Your blog is live at:

marklog.xyz/your-username/your-repo

Frontmatter Fields

title
Shows in the post list and browser tab
date
Used to sort posts (newest first). Format: YYYY-MM-DD
description
Shows as a preview in the post list
image
Cover image with url and alt fields
category
Post category
featured
Featured post flag
tags
Array of post tags
author
Post author

Config Options

blog.config.yaml

Example Configuration

title: My Blog
description: My personal blog
theme: pixel  # light | dark | ghibli | pixel
show_toc: true
show_repo_link: true
analytics:
  google: "G-XXXXXXXXXX"
title
Your blog name. Shows in the header and browser tab
description
A short tagline. Shows below the title
theme
Theme: light | dark | ghibli | pixel
show_toc
Show table of contents on posts. true or false
show_repo_link
Show "View on GitHub" link. true or false
analytics
Google Analytics ID. Example: analytics: { google: "G-XXXXXXXXXX" }

Pro Tips

  • Use descriptive filenames. how-to-learn-rust.md is better than post1.md
  • Changes appear instantly. Push to GitHub and your blog updates automatically.
  • Multiple blogs? No problem. Each repo with a /blog folder becomes a separate blog.

Ready to ship?

Stop configuring. Start writing.

BACK TO HOME