---
title: Welcome to MunchFile
description: Your files, live on the web — with beautiful rendering.
---

# Welcome to MunchFile

You just clicked a real MunchFile link. This is what it looks like on the other end.

---

## What happened here

Somewhere on someone's computer, there's a file called `welcome.md`. They ran one command:

```bash
munchfile watch ./welcome.md
```

That's it. MunchFile minted this URL, and every time that file is saved — this page updates automatically. Same link. Latest content. The file never left their machine.

---

## Beautiful by default

Your markdown comes alive with rich rendering — no configuration needed.

### Math

Formulas render natively. Write LaTeX inline like $E = mc^2$ or as display blocks:

$$
\int_0^\infty e^{-x} dx = 1
$$

Perfect for technical notes, research, or study guides. MunchFile uses ==KaTeX== for fast, server-side math rendering.

### Diagrams

Draw directly in markdown with Mermaid:

```mermaid
graph LR
  A[Your File] -->|save| B[MunchFile Daemon]
  B -->|upload| C[Cloudflare R2]
  C -->|serve| D[Live URL]
  D -->|auto-refresh| A
```

Flowcharts, sequence diagrams, Gantt charts, class diagrams, mind maps — all 15 Mermaid diagram types work out of the box.

### Code with syntax highlighting

```typescript
interface File {
  slug: string;
  filename: string;
  visibility: "private" | "unlisted" | "public";
}

function getUrl(file: File): string {
  return `https://view.munchfile.com/${file.slug}`;
}
```

Over 190 languages highlighted automatically. No plugins, no config.

---

## Try it yourself

- [ ] Install the CLI
- [ ] Log in with magic link
- [ ] Watch a file — get a URL in ~300ms
- [x] Share the link. Done.

**1. Install**

```bash
npm install -g @munchfile/cli
```

**2. Log in** (magic link — no password)

```bash
munchfile login
```

**3. Watch any `.md` or `.html` file**

```bash
munchfile watch ./your-notes.md
```

You'll get a link like this one. :rocket:

---

## What you can share

| Format | Extensions | Rendering |
|--------|------------|-----------|
| Markdown | `.md`, `.markdown` | Math, diagrams, callouts, tables |
| HTML | `.html`, `.htm` | As-is with CSP protection |

More formats coming. For now: if it's a document, it works.

---

## Rich formatting at a glance

MunchFile supports the full markdown toolkit:

==Highlight important passages==, add H~2~O-style subscripts, write mathematical notation like m^2^, and organize thoughts with :sparkles: emoji shortcodes.

> [!NOTE]
> MunchFile is in active development. New features ship weekly — you're seeing the latest build right now.

> [!TIP]
> Use `[TOC]` at the top of any document to auto-generate a table of contents from your headings.

---

## The idea

Most tools want you to move your files somewhere — a cloud folder, a web app, a sync service. MunchFile doesn't. Your files stay exactly where they are. You just get a URL that stays fresh.

Edit locally. Share the link. Done.

### Key terms

MunchFile
:   A zero-friction tool that gives local markdown and HTML files a live URL. Files stay on your machine — MunchFile syncs content, not location.

Daemon
:   A lightweight background process that watches your files for changes and uploads new content automatically. Starts when you run `munchfile start`.

---

*Made with [MunchFile](https://munchfile.com)*