Docs

Four ways to turn AI output into a link — share from wherever the work happens.

Option 1Web paste

Open korx.org, pick HTML or Markdown, paste or drop a file, and hit "Generate Share Link". The result card shows your URL and a one-time edit code — save it to update the same link later.

Option 2Claude Code skill

Once installed, saying "share this" in Claude Code gets you a link. Create ~/.claude/skills/korx-share/SKILL.md with:

---
name: korx-share
description: Share markdown or HTML as a public korx.org link (typeset reading page / interactive HTML page). Trigger when the user says "share this / publish this / give me a share link / share to korx". Also updates existing shares via edit_code.
---

# Korx Share — one curl, one link

korx.org typesets markdown into a Kami-style reading page (parchment ground,
ink-blue accent, serif hierarchy). HTML is hosted as-is, fully interactive.

## Create a share

```bash
curl -s -X POST https://korx.org/api/share \
  -H "Content-Type: application/json" \
  -d '{"type":"markdown","title":"Optional title","content":"<content>"}'
```

- type: "markdown" or "html" (default html)
- For long content, write the JSON to a temp file and use --data @payload.json
- Response: {id, url, raw_url, edit_code}

## Delivery rules

1. Report the url as the main deliverable.
2. Always report the edit_code and remind the user to save it —
   it is returned only once.
3. raw_url (/v/{id}/raw) serves the original markdown; mention when useful.

## Update an existing share (same link)

```bash
curl -s -X PUT https://korx.org/api/share/<id> \
  -H "Content-Type: application/json" \
  -d '{"content":"<new content>","edit_code":"<edit_code>"}'
```

Pages are edge-cached for 1 hour; stale content may linger up to 1h after updates.

Option 3MCP (Claude Desktop, etc.)

The MCP server is on npm and provides two tools: share_html and share_markdown. Add to your MCP config (e.g. claude_desktop_config.json):

{
  "mcpServers": {
    "korx-share": {
      "command": "npx",
      "args": ["-y", "korx-share-mcp-server"]
    }
  }
}

Option 4Obsidian plugin

Share the current note as a reading page with one command; running it again updates the same link (share state lives in the note's frontmatter).

Install

1. Unzip, rename the korx-share-obsidian folder to korx-share, and drop it into your vault's .obsidian/plugins/;
2. Obsidian Settings → Community plugins → enable Korx Share;
3. Open the command palette (Cmd/Ctrl+P) and search "Korx".

Usage

• Note menu: the tab's "More options" menu or the file explorer's context menu → 分享文档 (Share document); already-shared notes also get a copy-link item.
• Command palette: "Share current note (create or update link)" and "Copy share link of current note".
• On first share the URL is copied to your clipboard and korx_id / korx_url / korx_edit_code are written into frontmatter (frontmatter itself is stripped from the shared content); sharing again updates the same link.

AppendixAPI & limits

• POST /api/share to create, PUT /api/share/{id} to update with the edit code, GET /v/{id}/raw for the original source;
• Content is capped at 2MB per share; pages are edge-cached for 1 hour;
• The edit code is returned exactly once at creation — if lost, re-share instead.