|
1 | 1 | # ⚡ Flashtype |
2 | 2 |
|
3 | | -A **Claude Code-style WYSIWYG markdown editor in the browser**. |
| 3 | +**A demonstration and development target for the [Lix](https://lix.dev) version control system.** |
4 | 4 |
|
5 | | -Flashtype delivers a Claude Code-like experience for markdown editing with true WYSIWYG rendering, AI-powered assistance, and markdown as source of truth. Built on Lix for change control, it runs entirely in your browser with zero installation required. |
| 5 | +Flashtype is a WYSIWYG markdown editor built on the Lix SDK. It serves as both a showcase for Lix's capabilities and a real-world application that drives the SDK's development—proving that embeddable version control enables powerful features like AI-assisted editing, change proposals, and full document history, all running entirely in the browser. |
6 | 6 |
|
7 | | -## 🚀 Why Flashtype? |
| 7 | +## 🎯 What This Demonstrates |
8 | 8 |
|
9 | | -Claude Code experience. WYSIWYG markdown. Markdown as source of truth. |
| 9 | +Flashtype demonstrates key Lix capabilities: |
10 | 10 |
|
11 | | -- 👁️ **WYSIWYG Markdown** — no annoying previews, see formatted text as you type |
12 | | -- 🌐 **Runs in Browser** — zero installation, works everywhere, no server needed |
13 | | -- 🤖 **Claude Code AI** — diffs, accept/reject changes, contextual assistance |
14 | | -- 📋 **Markdown Source of Truth** — no import/export, markdown is your actual document format |
| 11 | +| Lix Feature | How Flashtype Uses It | |
| 12 | +| ----------------------- | ----------------------------------------------------------------------------- | |
| 13 | +| **History** | Every edit is tracked. See exactly what changed, when, and by whom. | |
| 14 | +| **Versions (Branches)** | AI generates content in isolated versions, letting you review before merging. | |
| 15 | +| **Diffs** | Claude Code-style accept/reject UI shows granular changes inline. | |
| 16 | +| **Change Proposals** | AI proposes edits, humans stay in control of what ships. | |
| 17 | +| **Single SQLite File** | Your documents persist in browser storage as a portable `.lix` file. | |
15 | 18 |
|
16 | | -### Problems Flashtype solves |
| 19 | +## 🚀 Try It |
17 | 20 |
|
18 | | -| Problem | Flashtype Solution | |
19 | | -| -------------------------------------------------- | --------------------------------------------------- | |
20 | | -| Annoying preview tabs and mode switching | True WYSIWYG markdown rendering | |
21 | | -| Installing heavy desktop apps for markdown editing | Runs entirely in browser, zero install | |
22 | | -| Poor AI integration in existing editors | Claude Code-style AI with diffs & accept/reject | |
23 | | -| Markdown compatibility issues between tools | Uses markdown as source of truth - works everywhere | |
| 21 | +Visit [flashtype.ai](https://flashtype.ai) to try it in your browser—no installation required. |
24 | 22 |
|
25 | | -## 🧠 What Makes Flashtype Different |
| 23 | +## 🔗 Learn More About Lix |
26 | 24 |
|
27 | | -### 👁️ WYSIWYG Markdown in Browser |
| 25 | +Lix is an embeddable version control system that enables Git-like features for any file format: |
28 | 26 |
|
29 | | -No more annoying preview tabs. Type `# Heading` and see it rendered as a heading instantly. Format text with `**bold**` and see it bold immediately. Pure WYSIWYG markdown editing - what you see is what you get. |
| 27 | +- **[Lix Documentation](https://lix.dev/docs)** — Full SDK reference and guides |
| 28 | +- **[Getting Started](https://lix.dev/docs/getting-started)** — Build your first app with Lix |
| 29 | +- **[GitHub](https://github.com/opral/lix-sdk)** — Report issues and contribute |
| 30 | +- **[Discord](https://discord.gg/gdMPPWy57R)** — Get help and join the community |
30 | 31 |
|
31 | | -### 🌐 Zero Install, Runs Anywhere |
| 32 | +## 📋 Features |
32 | 33 |
|
33 | | -Open in any browser - Chrome, Safari, Firefox. No downloads, no installations, no desktop apps. Your documents live in browser storage, work offline, and sync optionally. |
34 | | - |
35 | | -Flashtype is also installable as a Progressive Web App (PWA). In any supported browser, open the app, choose **Install** from the address bar menu, and you’ll get a standalone window with offline support and taskbar/dock integration. |
36 | | - |
37 | | -### 🤖 Claude Code AI Experience |
38 | | - |
39 | | -AI that understands your markdown. Generate content, get suggestions, review diffs, and accept/reject changes just like Claude Code. Copy your markdown and paste it directly into ChatGPT or any other tool. |
40 | | - |
41 | | -### 📋 Markdown as Source of Truth |
42 | | - |
43 | | -No lossy import/export cycles. Your document IS markdown, not converted to/from markdown. Copy from Flashtype → paste into GitHub → paste back into Flashtype with zero data loss. No vendor lock-in, no proprietary formats. |
44 | | - |
45 | | -💡 **Why This Matters:** |
46 | | - |
47 | | -- Most editors convert markdown to their own format, creating lossy copy/paste |
48 | | -- Flashtype treats markdown as the native format - no conversion needed |
49 | | -- True lossless workflows between ChatGPT, GitHub, Discord, and more |
50 | | - |
51 | | -## 🎯 Perfect For |
52 | | - |
53 | | -- **Technical writers** who copy/paste between tools and need AI assistance |
54 | | -- **Content creators** tired of preview tabs and want seamless markdown editing |
55 | | -- **Developers** who want GitHub-compatible markdown without desktop apps |
56 | | -- **Anyone** who works with ChatGPT and wants lossless markdown workflows |
| 34 | +- **WYSIWYG Markdown** — No preview tabs. Type `# Heading` and see it rendered instantly. |
| 35 | +- **Claude Code-style AI** — Generate content, review diffs, accept/reject changes. |
| 36 | +- **Browser-native** — Zero install, works offline, syncs optionally. |
| 37 | +- **Markdown as Source of Truth** — Lossless copy/paste between tools like GitHub, ChatGPT, and Discord. |
0 commit comments