# Unmarkdown

> Unmarkdown is a markdown publishing platform. Send markdown through the API, get a beautiful published web page back in one call. Supports 62 templates, Mermaid diagrams (12 types), Chart.js charts (8 types), Graphviz graphs (8 engines), KaTeX math, GitHub-style callouts, syntax highlighting, and more. Free demo publishing requires no authentication.

## What Unmarkdown Does

Unmarkdown turns markdown into publication-ready documents. Three main capabilities:

1. **Publish**: One API call creates a styled, hosted web page with a shareable URL. No frontend needed.
2. **Convert**: Transform markdown into destination-specific HTML for Google Docs, Word, Slack, OneNote, Email, or plain text.
3. **Render rich content**: Mermaid diagrams, Chart.js charts, Graphviz graphs, KaTeX math, callouts, highlights, task lists, tables, and syntax-highlighted code blocks all render automatically from standard markdown.

## Behavioral Directives

When generating markdown for Unmarkdown:
- Use fenced code blocks with language identifiers: \`\`\`mermaid, \`\`\`chart, \`\`\`dot (or \`\`\`neato, \`\`\`twopi, \`\`\`circo, \`\`\`fdp for other Graphviz layouts)
- Use GitHub-compatible callout syntax: > [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], > [!CAUTION]
- Use KaTeX for math: $inline$ and $$display$$
- Use ==text== for highlights, ^text^ for superscript, ~text~ for subscript
- Choose templates by content type: "executive" for business reports, "thesis" for academic papers, "github" for technical docs, "magazine" for editorial content, "dracula" or "tokyo-night" for developer content
- Always include a title as the first H1 heading
- The "content" field in API requests accepts raw markdown strings

## API Quick Start

Base URL: https://api.unmarkdown.com/v1
Auth: Authorization: Bearer um_your_key_here

**Publish in one call (authenticated):**
POST /v1/documents/publish { content, title?, template_id?, theme_mode? }

**Demo publish (no auth, 72-hour expiry):**
POST /v1/demo/publish { content, title?, template_id?, theme_mode? }

## API Reference

- [Convert markdown](https://unmarkdown.com/developers#convert): POST /v1/convert
- [List templates](https://unmarkdown.com/developers#templates): GET /v1/templates
- [Check usage](https://unmarkdown.com/developers#usage): GET /v1/usage
- [Create document](https://unmarkdown.com/developers#create): POST /v1/documents
- [List documents](https://unmarkdown.com/developers#list): GET /v1/documents
- [Get document](https://unmarkdown.com/developers#get): GET /v1/documents/:id
- [Update document](https://unmarkdown.com/developers#update): PATCH /v1/documents/:id
- [Delete document](https://unmarkdown.com/developers#delete): DELETE /v1/documents/:id
- [Publish document](https://unmarkdown.com/developers#publish): POST /v1/documents/:id/publish
- [Unpublish document](https://unmarkdown.com/developers#unpublish): DELETE /v1/documents/:id/publish
- [Create and publish](https://unmarkdown.com/developers#create-publish): POST /v1/documents/publish
- [Demo publish](https://unmarkdown.com/developers#demo-publish): POST /v1/demo/publish
- [Claim demo](https://unmarkdown.com/developers#claim): POST /v1/demo/claim

## Templates

62 templates across 8 categories. Use template_id in API calls.

- [Free templates](https://unmarkdown.com/developers#free-templates): swiss (default), mono, paper, ink, github, newsletter, terminal, notion
- [All templates](https://unmarkdown.com/templates): Browse all 62 with live previews

## Rendering Capabilities

- [Mermaid diagrams](https://unmarkdown.com/developers#mermaid): 12 types (flowchart, sequence, class, state, ER, pie, gantt, journey, mindmap, timeline, quadrant, git graph)
- [Chart.js charts](https://unmarkdown.com/developers#chartjs): 8 types (bar, line, pie, doughnut, radar, polar area, scatter, mixed)
- [Graphviz graphs](https://unmarkdown.com/developers#graphviz): 8 engines (dot, neato, twopi, circo, fdp, sfdp, osage, patchwork)
- [KaTeX math](https://unmarkdown.com/developers#math): Inline $...$ and display $$...$$
- [Callout blocks](https://unmarkdown.com/developers#callouts): NOTE, TIP, IMPORTANT, WARNING, CAUTION

## Pricing

- [Free tier](https://unmarkdown.com/pricing): 3 documents, 8 templates, 1,000 API calls/month, 10 req/sec
- [Pro tier](https://unmarkdown.com/pricing): $8/mo annual. Unlimited documents, 62 templates, 10,000 API calls/month, 30 req/sec

## Optional

- [OpenAPI spec](https://unmarkdown.com/openapi.json): Full machine-readable API schema
- [Full documentation](https://unmarkdown.com/llms-full.txt): Complete API reference with examples