# JotBird

> JotBird is an online Markdown editor with live preview and one-click publishing. Write Markdown, publish it to a shareable URL in seconds, and update or delete it anytime. No account required for basic publishing.

## What JotBird Does

- Publish Markdown to a shareable URL
- Update or delete published pages at any time
- Live preview in a split-pane editor
- Syntax highlighting for fenced code blocks (190+ languages)
- Mermaid diagrams rendered as SVG
- KaTeX math expressions (inline and block)
- Obsidian-style callouts (NOTE, TIP, WARNING, CAUTION, IMPORTANT)
- GitHub-flavored Markdown tables, task lists, strikethrough
- Highlighted text, footnotes, subscript, superscript, definition lists
- Image hosting (paste, drag, or upload — hosted with the page)
- Emoji shortcodes
- YAML frontmatter (recognized and stripped from output)

## Writing Markdown for JotBird

Use standard GitHub-flavored Markdown. These guidelines produce the best results:

- Always include an H1 title (`# Title`) as the first heading
- Use fenced code blocks with language identifiers for syntax highlighting:
  ````
  ```python
  print("hello")
  ```
  ````
- Use ` ```mermaid ` for diagrams. Supported types: flowchart, sequence, class, state, ER, gantt, pie, mindmap, timeline, quadrant, gitgraph, sankey, xy-chart
- Use `$...$` for inline math and `$$...$$` for block math (KaTeX)
- Use callouts with `> [!NOTE]`, `> [!TIP]`, `> [!WARNING]`, `> [!CAUTION]`, `> [!IMPORTANT]`
- Use `==text==` for highlighted text
- Images can be referenced by URL: `![alt](https://example.com/image.png)`
- HTML comments (`<!-- -->`) are stripped from published output
- A small subset of inline HTML is allowed (p, br, a, strong, em, code, pre, ul, ol, li, table elements, headings). Script tags, iframes, and event handlers are stripped.

## Accessing Published Pages as Markdown

Every published JotBird page is available as raw Markdown:

- **Append `.md` to the URL**: `https://share.jotbird.com/my-page.md`
- **Send `Accept: text/markdown` header**: Any HTTP client or AI agent can request the Markdown directly

The Markdown response includes YAML frontmatter:

```yaml
---
title: Page Title
url: https://share.jotbird.com/my-page
updated_at: 2026-03-07T12:00:00.000Z
---
```

## Publishing Channels

- **[Web App](https://www.jotbird.com/app)** — Browser-based editor with live preview
- **[Obsidian Plugin](https://www.jotbird.com/obsidian)** — Publish directly from Obsidian
- **[VS Code Extension](https://www.jotbird.com/vscode)** — Publish from VS Code
- **[CLI](https://www.jotbird.com/cli)** — Publish from the terminal: `jotbird publish file.md`
- **[API](https://www.jotbird.com/docs/api)** — REST API for publishing, listing, and deleting documents
- **[MCP Server](https://www.jotbird.com/mcp)** — Publish from AI assistants via the Model Context Protocol

## Pricing

**Anonymous (no account):**
- Publish from the web app, VS Code extension, or Obsidian plugin
- Links expire in 30 days
- No API or CLI access

**Free (with account):**
- All publishing channels including API and CLI
- Links expire in 90 days
- 10 pages via API/CLI

**Pro ($29/year):**
- Permanent links that never expire
- Custom URLs (e.g., `share.jotbird.com/@clayton-myers/my-guide`)
- Unlimited API/CLI pages

## Links

### Product
- [Homepage](https://www.jotbird.com/index.md)
- [What is JotBird](https://www.jotbird.com/what-is-jotbird.md)
- [Pro](https://www.jotbird.com/pro.md)
- [Help](https://www.jotbird.com/help.md)

### Templates
- [Templates Gallery](https://www.jotbird.com/templates.md)
- [README Template](https://www.jotbird.com/templates/readme.md)
- [Resume / CV Template](https://www.jotbird.com/templates/resume.md)
- [Meeting Notes Template](https://www.jotbird.com/templates/meeting-notes.md)
- [Technical Proposal Template](https://www.jotbird.com/templates/technical-proposal.md)
- [Changelog Template](https://www.jotbird.com/templates/changelog.md)
- [Blog Post Template](https://www.jotbird.com/templates/blog-post.md)
- [Weekly Review Template](https://www.jotbird.com/templates/weekly-review.md)
- [Book Review Template](https://www.jotbird.com/templates/book-review.md)
- [Recipe Template](https://www.jotbird.com/templates/recipe.md)
- [Mermaid Flowchart Template](https://www.jotbird.com/templates/mermaid-flowchart.md)

### Developers
- [API Documentation](https://www.jotbird.com/docs/api.md)
- [CLI](https://www.jotbird.com/cli.md)
- [MCP Server](https://www.jotbird.com/mcp.md)

### Clients
- [VS Code Extension](https://www.jotbird.com/vscode.md)
- [Obsidian Plugin](https://www.jotbird.com/obsidian.md)

### Legal
- [Privacy Policy](https://www.jotbird.com/privacy.md)
- [Terms of Service](https://www.jotbird.com/terms.md)