docs: add twoslash-remote documentation (#92)

Author: antfubot

docs/.vitepress/config.ts

@@ -28,6 +28,7 @@ const INTEGRATIONS = [
   { text: 'Svelte Language Support', link: '/packages/svelte' },
   { text: 'ESLint TwoSlash', link: '/packages/eslint' },
   { text: 'CDN Usage', link: '/packages/cdn' },
+  { text: 'Remote API', link: '/packages/remote' },
 ] satisfies DefaultTheme.SidebarItem[]
 
 const VERSIONS = [

docs/packages/remote.md

@@ -0,0 +1,65 @@
+# Twoslash Remote
+
+Run [Twoslash](https://github.com/twoslashes/twoslash) by delegating resolution to a remote HTTP API. Keep the heavy dependencies (TypeScript, type acquisition, virtual file system, Vue language server, ...) on a server and ship only a tiny client to the browser, build pipeline, or edge function.
+
+The package exposes two entry points:
+
+- `twoslash-remote` — a client that sends a code snippet + metadata to your endpoint and resolves the `TwoslashGenericResult` you get back.
+- `twoslash-remote/server` — web-standard `Request → Response` helpers to implement the contract on the server side, with any backend that returns a `TwoslashGenericResult` (`twoslash`, `twoslash-eslint`, `twoslash-vue`, or your own).
+
+## Usage
+
+### Client
+
+```ts
+import { createTwoslashFromRemote } from 'twoslash-remote'
+
+const twoslash = createTwoslashFromRemote({
+  endpoint: 'https://my-api.example.com/twoslash',
+})
+
+const result = await twoslash.run(
+  `
+    const count = 1
+    //    ^?
+  `,
+  'ts',
+  // Optional: serializable twoslasher options forwarded to the backend
+  { compilerOptions: { strict: true } },
+  // Optional: transport-level options (meta, headers, signal)
+  { meta: { tenant: 'docs-site' } },
+)
+
+console.log(result) // { code: '...', nodes: [...] }
+```
+
+The third argument is forwarded to the server backend as `options` in the request body. The fourth argument is transport-only (`meta`, `headers`, `signal`).
+
+### Server
+
+`createTwoslashRequestHandler` returns a web-standard `(req: Request) => Promise<Response>`. It runs in Node ≥ 18, Bun, Deno, Cloudflare Workers, Vercel/Netlify edge functions, and any framework that speaks the fetch API.
+
+```ts
+import { createTwoslasher } from 'twoslash'
+import { createTwoslashRequestHandler } from 'twoslash-remote/server'
+
+const twoslasher = createTwoslasher()
+
+export default createTwoslashRequestHandler({
+  twoslasher,
+  cors: true,
+})
+```
+
+Plug in any backend that returns a `TwoslashGenericResult` — `twoslash-eslint`, `twoslash-vue`, or a custom wrapper:
+
+```ts
+import { createTwoslasher as createESLintTwoslasher } from 'twoslash-eslint'
+import { createTwoslashRequestHandler } from 'twoslash-remote/server'
+
+const twoslasher = createESLintTwoslasher({ eslintConfig: [/* ... */] })
+
+export default createTwoslashRequestHandler({ twoslasher })
+```
+
+Lower-level building blocks (`parseTwoslashRequest`, `serializeTwoslashError`) are also exported for users who want to integrate into a framework manually.