Getting started

Folder Blog publishes markdown from a GitHub repository. The repository stays the source of truth: edit locally or on GitHub, push, then let Folder Blog build the result.

1. Sign in with GitHub

Open folder.blog and choose Sign in with GitHub. After sign-in, open the dashboard and choose Create Blog.

2. Connect a repository

Choose From GitHub and enter a repository as owner/repository. The current setup connects the repository's main branch and uses posts as its content folder.

If you want a starting point, copy one of the public starter repositories before connecting it. Template selection is not yet built into the dashboard.

3. Choose a subdomain

Enter a blog name and an available slug. A slug such as field-notes publishes at field-notes.folder.blog. Slugs contain 3–50 lowercase letters, numbers, or dashes and cannot start or end with a dash.

4. Add your first post

Create a markdown file inside the connected posts folder:

posts/
└── hello-world.md

---
title: Hello World
date: 2026-08-08
tags: [hello]
---

This post lives in my GitHub repository.

title and date are recommended but not required by the processor. Without a title, Folder Blog derives one from the filename. See the frontmatter reference for publication controls such as drafts, hidden posts, and future dates.

5. Push and publish

Commit and push the file to main. Folder Blog can rebuild from the connected repository; Sync Now on the blog dashboard is the manual way to request the latest content after a push. Published posts use /posts/<slug> URLs.

Next steps

• Content and configuration — folders, frontmatter, images, wikilinks, and current customization limits
• API reference — read published content as JSON, RSS, or XML
• Self-hosting — build portable JSON, run the Node server, and consume it through the typed remote client
• FAQ — ownership, Obsidian, custom domains, and mobile workflows