π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
feat: amber/gold brand identity with mascot SVG
Luis Ortiz30b2e1ce6cee
diff --git a/AGENTS.md b/AGENTS.mdindex 0af766d..b9f9b9d 100644--- a/AGENTS.md+++ b/AGENTS.md@@ -19,25 +19,14 @@ You click "Record," perform a workflow in your browser, and Mimik automatically## Features-| Feature | Description |-|---------|-------------|-| **Record** | Click the extension, perform your workflow. Every click/input auto-captures a screenshot with the element highlighted and a description generated. rrweb DOM recording runs alongside for video-like playback. |-| **Edit** | Side panel UI to reorder steps, rename titles, edit descriptions, blur sensitive areas on screenshots, delete steps. |-| **Replay** | Open a saved guide and hit replay. The extension walks through each step on the live page β finds elements, clicks/types for you, advances automatically. |-| **Export** | Download as self-contained HTML (offline), Markdown (for docs/wikis/repos), or PDF. All generated client-side. |-| **Settings** | Optional AI API key (OpenAI/Anthropic) for auto-generated step descriptions. Tool works without it. |-| **Storage** | All guides saved locally in IndexedDB. No account, no server, no data leaves the browser. |--## Not in Scope (v1)--- Backend / server of any kind-- User accounts / auth-- Team collaboration-- Sharing via URL-- Embed system-- Voice transcription-- Integrations (Notion, Slack, etc.)-- PII auto-redaction (can add in v2, it's client-side)+| Feature | Description |+| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| **Record** | Click the extension, perform your workflow. Every click/input auto-captures a screenshot with the element highlighted and a description generated. rrweb DOM recording runs alongside for video-like playback. |+| **Edit** | Side panel UI to reorder steps, rename titles, edit descriptions, blur sensitive areas on screenshots, delete steps. |+| **Replay** | Open a saved guide and hit replay. The extension walks through each step on the live page β finds elements, clicks/types for you, advances automatically. |+| **Export** | Download as self-contained HTML (offline), Markdown (for docs/wikis/repos), or PDF. All generated client-side. |+| **Settings** | Optional AI API key (OpenAI/Anthropic) for auto-generated step descriptions. Tool works without it. |+| **Storage** | All guides saved locally in IndexedDB. No account, no server, no data leaves the browser. |## Tech Stack@@ -57,13 +46,3 @@ You click "Record," perform a workflow in your browser, and Mimik automatically- **Workflow engine** is an XState state machine managing capture lifecycle, guidance, and replay- **Replay** finds elements on live pages, executes click/type/scroll actions, advances through steps- **rrweb** records DOM mutations for video-like session playback--## Differentiators vs Competitors--- **No account required** β install and use immediately-- **No data leaves the browser** β screenshots and guides stored locally-- **No limits** β unlimited guides, no watermarks, no per-seat pricing-- **True offline exports** β self-contained HTML with base64 embedded screenshots-- **Markdown export** β git-friendly, store guides alongside code in your repo-- **Replay** β automated workflow replay from saved guides-- **Open source, MIT licensed**diff --git a/public/mascot.svg b/public/mascot.svgnew file mode 100644index 0000000..7eae20d--- /dev/null+++ b/public/mascot.svg@@ -0,0 +1,18 @@+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 200" width="200" height="200">+ <defs>+ <clipPath id="cc"><circle cx="100" cy="100" r="95"/></clipPath>+ </defs>+ <g clip-path="url(#cc)">+ <rect x="-50" y="-50" width="300" height="300" fill="#FDE68A"/>+ <rect x="30" y="-80" width="50" height="400" fill="#F59E0B" transform="rotate(45, 100, 100)" opacity="0.15"/>+ <rect x="90" y="-80" width="50" height="400" fill="#D97706" transform="rotate(45, 100, 100)" opacity="0.12"/>+ <rect x="-30" y="-80" width="50" height="400" fill="#FCD34D" transform="rotate(45, 100, 100)" opacity="0.15"/>+ <rect x="150" y="-80" width="50" height="400" fill="#FBBF24" transform="rotate(45, 100, 100)" opacity="0.1"/>+ </g>+ <rect x="30" y="95" width="140" height="68" rx="5" fill="#451a03"/>+ <path d="M30 95 L30 80 Q30 60, 100 60 Q170 60, 170 80 L170 95 Z" fill="#572508"/>+ <rect x="30" y="93" width="140" height="3" fill="#FDE68A"/>+ <path d="M68 122 Q76 112 84 122" stroke="#FDE68A" stroke-width="5" fill="none" stroke-linecap="round"/>+ <path d="M116 122 Q124 112 132 122" stroke="#FDE68A" stroke-width="5" fill="none" stroke-linecap="round"/>+ <path d="M84 138 Q100 148 116 138" stroke="#FDE68A" stroke-width="3.5" fill="none" stroke-linecap="round"/>+</svg>diff --git a/src/content/events.ts b/src/content/events.tsindex c7ad51f..158dadb 100644--- a/src/content/events.ts+++ b/src/content/events.ts@@ -69,7 +69,7 @@ function createHighlightOverlay(): HTMLDivElement {el.style.cssText = `position: fixed;pointer-events: none;- border: 3px solid #3B82F6;+ outline: 2.5px dashed #F59E0B;border-radius: 6px;z-index: 2147483647;box-sizing: border-box;diff --git a/src/options/App.tsx b/src/options/App.tsxindex 9680e53..0143365 100644--- a/src/options/App.tsx+++ b/src/options/App.tsx@@ -57,7 +57,7 @@ export default function App() {<buttononClick={handleSave}- className="w-full py-2 px-4 bg-blue-600 text-white rounded-md font-medium hover:bg-blue-700 transition-colors text-sm"+ className="w-full py-2 px-4 bg-amber-600 text-white rounded-md font-medium hover:bg-amber-700 transition-colors text-sm">{saved ? 'Saved!' : 'Save Settings'}</button>diff --git a/src/sidepanel/BlurCanvas.tsx b/src/sidepanel/BlurCanvas.tsxindex cc4ace3..e3b8490 100644--- a/src/sidepanel/BlurCanvas.tsx+++ b/src/sidepanel/BlurCanvas.tsx@@ -199,7 +199,7 @@ export default function BlurCanvas({ screenshot, onSave, onCancel }: BlurCanvasP</button><buttononClick={handleSave}- className="flex items-center gap-1 px-3 py-1.5 text-sm text-white bg-blue-600 hover:bg-blue-700 rounded"+ className="flex items-center gap-1 px-3 py-1.5 text-sm text-white bg-amber-600 hover:bg-amber-700 rounded"title="Save blurred screenshot"><Check size={14} />diff --git a/src/sidepanel/ExportMenu.tsx b/src/sidepanel/ExportMenu.tsxindex 5205eba..f0c25c4 100644--- a/src/sidepanel/ExportMenu.tsx+++ b/src/sidepanel/ExportMenu.tsx@@ -82,7 +82,7 @@ export default function ExportMenu({ guide, steps, screenshots }: ExportMenuPropreturn (<div ref={menuRef} className="relative"><button- className="flex items-center gap-1 px-3 py-1.5 text-sm bg-blue-600 text-white rounded-lg hover:bg-blue-700 disabled:opacity-50 disabled:cursor-not-allowed"+ className="flex items-center gap-1 px-3 py-1.5 text-sm bg-amber-600 text-white rounded-lg hover:bg-amber-700 disabled:opacity-50 disabled:cursor-not-allowed"onClick={() => setOpen(prev => !prev)}disabled={exporting}title="Export guide"diff --git a/src/sidepanel/GuideEditor.tsx b/src/sidepanel/GuideEditor.tsxindex 1272d55..9c0fe22 100644--- a/src/sidepanel/GuideEditor.tsx+++ b/src/sidepanel/GuideEditor.tsx@@ -1,5 +1,5 @@import { useState, useEffect, useCallback } from 'react';-import { ArrowLeft } from 'lucide-react';+import { ArrowLeft, Maximize2 } from 'lucide-react';import { getGuide, updateGuideTitle, updateStepDescription, deleteStep, reorderSteps, updateScreenshotBlob } from '../shared/guide-service';import type { Guide, Step, Screenshot } from '../shared/types';import StepCard from './StepCard';@@ -123,11 +123,28 @@ export default function GuideEditor({ guideId, onBack }: GuideEditorProps) {<ArrowLeft size={18} /></button><input- className="text-lg font-bold bg-transparent border-b border-transparent hover:border-gray-300 focus:border-blue-500 focus:outline-none w-full"+ className="text-lg font-bold bg-transparent border-b border-transparent hover:border-gray-300 focus:border-amber-500 focus:outline-none w-full"value={title}onChange={(e) => setTitle(e.target.value)}onBlur={handleTitleBlur}/>+ <button+ onClick={() => {+ const url = chrome.runtime.getURL(`/fullview.html?guideId=${guideId}`);+ chrome.tabs.query({ url: chrome.runtime.getURL('/fullview.html*') }).then(tabs => {+ if (tabs.length > 0 && tabs[0].id) {+ chrome.tabs.update(tabs[0].id, { active: true, url: chrome.runtime.getURL(`/fullview.html?guideId=${guideId}`) });+ if (tabs[0].windowId) chrome.windows.update(tabs[0].windowId, { focused: true });+ } else {+ chrome.tabs.create({ url });+ }+ });+ }}+ className="flex-shrink-0 text-gray-400 hover:text-amber-600 p-1 rounded"+ title="Open full view"+ >+ <Maximize2 size={16} />+ </button><div className="ml-auto flex-shrink-0"><ExportMenuguideId={guideId}@@ -146,7 +163,7 @@ export default function GuideEditor({ guideId, onBack }: GuideEditorProps) {data.steps.map((step, idx) => (<div key={step.id}>{dragOverIndex === idx && dragIndex !== null && dragIndex !== idx && (- <div className="h-1 bg-blue-500 rounded-full mx-4 mb-1" />+ <div className="h-1 bg-amber-500 rounded-full mx-4 mb-1" />)}<StepCardstep={step}diff --git a/src/sidepanel/StepCard.tsx b/src/sidepanel/StepCard.tsxindex 2ad3629..69d5d7f 100644--- a/src/sidepanel/StepCard.tsx+++ b/src/sidepanel/StepCard.tsx@@ -92,7 +92,7 @@ export default function StepCard({onDragOver={handleDragOver}onDragLeave={handleDragLeave}onDragEnd={handleDragEnd}- className={`p-3 border rounded-lg mb-2 ${dragOver ? 'border-t-2 border-blue-500' : 'border-gray-200'}`}+ className={`p-3 border rounded-lg mb-2 ${dragOver ? 'border-t-2 border-amber-500' : 'border-gray-200'}`}><div className="flex items-start gap-2">{dragHandleProps && (@@ -100,7 +100,7 @@ export default function StepCard({<GripVertical size={14} className="text-gray-300" /></div>)}- <span className="flex items-center justify-center w-6 h-6 rounded-full bg-blue-600 text-white text-xs font-bold flex-shrink-0 mt-0.5">+ <span className="flex items-center justify-center w-6 h-6 rounded-full bg-amber-600 text-white text-xs font-bold flex-shrink-0 mt-0.5">{step.index + 1}</span><div className="flex-1 min-w-0">@@ -116,7 +116,7 @@ export default function StepCard({</div>)}<textarea- className="w-full text-sm border border-transparent hover:border-gray-300 focus:border-blue-500 focus:ring-1 focus:ring-blue-500 rounded p-1 resize-none"+ className="w-full text-sm border border-transparent hover:border-gray-300 focus:border-amber-500 focus:ring-1 focus:ring-amber-500 rounded p-1 resize-none"value={description}rows={2}onChange={(e) => setDescription(e.target.value)}@@ -131,7 +131,7 @@ export default function StepCard({<><buttononClick={() => onBlur?.(step.id)}- className="text-gray-400 hover:text-blue-500 p-1 rounded"+ className="text-gray-400 hover:text-amber-500 p-1 rounded"title="Blur sensitive area"><EyeOff size={14} />diff --git a/src/sidepanel/ZoomScreenshot.tsx b/src/sidepanel/ZoomScreenshot.tsxindex 4262294..d6bd135 100644--- a/src/sidepanel/ZoomScreenshot.tsx+++ b/src/sidepanel/ZoomScreenshot.tsx@@ -86,7 +86,7 @@ export default function ZoomScreenshot({ screenshot, className = '', alt = '' }:const scaleX = imgW / visW;const scaleY = imgH / visH;- ctx.strokeStyle = '#2563EB';+ ctx.strokeStyle = '#D97706';ctx.lineWidth = 10;drawRoundedRect(ctx,