Preview a README as a styled document, outside GitHub

A README is markdown at its densest: code fences, tables, install commands. Paste one here to see it as a designed document — for docs sites, PDF handoffs, or just reading it properly. Below is a real example rendered in Carbon.

What goes in, what comes out

The markdown below is the raw input. Under it: the same document rendered in the Carbon theme — embedded here exactly as the editor would export it.

See the markdown source
# tidyq

A tiny queue with backpressure, retries, and nothing else.

## Install

```bash
bun add tidyq
```

## Usage

```ts
import { queue } from 'tidyq'

const q = queue({ concurrency: 4, retries: 2 })

for (const job of jobs) q.push(() => process(job))
await q.drain()
```

## Why another queue?

| | tidyq | typical alternative |
|---|---|---|
| Dependencies | 0 | 12+ |
| Size | 1.1 kB | 40 kB+ |
| Backpressure | built-in | plugin |

## API

- `queue(opts)` — create a queue. `concurrency` (default 1), `retries` (default 0).
- `q.push(fn)` — enqueue a task returning a promise.
- `q.drain()` — resolves when the queue is empty.

## License

MIT

tidyq

A tiny queue with backpressure, retries, and nothing else.

Install

bun add tidyq

Usage

import { queue } from 'tidyq'

const q = queue({ concurrency: 4, retries: 2 })

for (const job of jobs) q.push(() => process(job))
await q.drain()

Why another queue?

tidyq typical alternative
Dependencies 0 12+
Size 1.1 kB 40 kB+
Backpressure built-in plugin

API

  • queue(opts) — create a queue. concurrency (default 1), retries (default 0).
  • q.push(fn) — enqueue a task returning a promise.
  • q.drain() — resolves when the queue is empty.

License

MIT

Open the exported file — one self-contained HTML document, no external requests.

Is code syntax-highlighted?

Yes — fenced code blocks are highlighted at render time (Shiki, the same highlighter VS Code uses) in a palette matched to the theme, and the highlighting survives into the exported HTML and PDF.

Can I use this for docs that live outside a repo?

That is the point — the export is one self-contained HTML file with no external requests, so it can be attached, hosted anywhere, or printed without touching GitHub.

More ways in

Browse all themes, or go straight to markdown → PDF / markdown → HTML.

100% in your browser · no upload · free · no sign-up