// documentation for frontend engineers

Your code,
documented
instantly.

Paste any JS or TS code. Get a full props table, README, usage examples, and Storybook args structured and copy-ready in seconds.

No prompting. No reformatting.

Try it freeSee pricing

Full generation free · Export unlocks at $9

10s

avg generation

5

output formats

readmi.dev/app

// input

interface ButtonProps {
  label: string
  onClick: () => void
  variant?: 'primary' | 'ghost'
  disabled?: boolean
}

export function Button({
  label, onClick,
  variant = 'primary',
  disabled = false
}: ButtonProps) { ... }

// output — props table

nametypereq
labelstringyes
onClick() => voidyes
variant'primary'|'ghost'opt
disabledbooleanopt

// why readmi

Stop fighting Claude.
Just get your docs.

Claude is powerful. But it's not a documentation tool. readmi is purpose-built for exactly this.

// without readmi

✕Craft a new prompt every single time
✕Get back an unstructured wall of text
✕Manually reformat everything yourself
✕No real props table, no Storybook output
✕Context switch out of your editor constantly
✕Five minutes minimum, per component

// with readmi

✓Prompt already optimized for doc output
✓Structured props table, README, Storybook args
✓Copy-ready output, nothing to reformat
✓Complete .stories.tsx file generated automatically
✓Web app and VS Code extension (coming soon)
✓Ten to fifteen seconds

// what you get

Everything a component
needs to be documented.

Five structured outputs on every run. No extra steps.

⊞

Props table

Name, type, required, default, and description for every prop. Automatically inferred from your code.

⊟

README section

Markdown-ready block you can paste straight into GitHub. No editing needed.

⊡

Usage example

A real code example built from your component's actual signature and prop types.

◉

unique

Storybook export

The only doc tool that generates a complete .stories.tsx file — argTypes, inferred control types, and a default Story. All ready to paste.

const meta: Meta<typeof Button> = {
  title: 'Components/Button',
  component: Button,
  argTypes: {
    label: {
      control: 'text',
      description: 'Button text',
    },
    variant: {
      control: 'select',
      options: ['primary', 'ghost'],
    },
    disabled: {
      control: 'boolean',
    },
  },
}

◈

Stack detection

Detects React, TypeScript, Tailwind, Zustand, and more. Automatically.

// pricing

Simple.
No gotchas.

Use it free, forever. Pay once when you're ready to ship the output.

$0

free

no account needed

✓Full props table — all props
✓Stack detection
✓Preview all output tabs
—Copy to clipboard
—README export
—Storybook file download
start for free
most popular

$9

full access

one-time · yours forever

✓Everything in free
✓Copy to clipboard
✓README export
✓Usage examples
✓Storybook file export
✓VS Code extension (coming soon)
unlock for $9
coming soon

readmi in your editor.
Zero context switching.

The VS Code extension brings readmi directly into your workflow. Highlight a component, run the command, get structured docs — without ever leaving your editor. Your $9 license covers it.

VS Codecoming soon

// get started

Paste your first component.
See what happens.

No account. No credit card. Just your code and your docs.

open readmi free