Getting Started

Install

Download the DMG from GitHub Releases, open it, and drag moss to your Applications folder.

Requirements: macOS 12 or later. The binary runs natively on both Intel and Apple Silicon.

Windows and Linux support is planned.

Your First Site

Create a folder anywhere — for example, ~/my-site — and add these files:

index.md

---
title: My Site
description: A personal website built with moss.
---

Welcome to my site. This is the homepage.

about.md

---
title: About
nav: true
weight: 2
---

This page appears in the navigation bar.

posts/hello.md

---
title: Hello World
date: 2024-01-15
---

My first blog post. Markdown works: **bold**, *italic*, [links](https://example.com).

Right-click the my-site folder in Finder, choose Publish with moss, and a preview opens in the app.

What Just Happened

moss scanned the folder, converted each markdown file to HTML, generated navigation from the folder structure and frontmatter, applied a default theme with dark mode support, and started a local preview server — all without uploading anything or modifying your files.

Next Steps

Published with moss