Skip to content

Commit f383f2e

Browse files
authored
Docs/improve readme (#10)
* 优化 react-flow 句柄的过渡效果,移除缩放效果,增加阴影效果 * Improve README presentation
1 parent a1d8a50 commit f383f2e

1 file changed

Lines changed: 57 additions & 44 deletions

File tree

README.md

Lines changed: 57 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,69 @@
1-
# ScriptFlow
1+
<div align="center">
2+
<img src="./public/scriptflow-brand-icon.png" width="96" height="96" alt="ScriptFlow Logo" />
23

3-
一个面向编导、短视频创作者、写作者的可视化脚本工作台。
4+
# ScriptFlow
45

5-
把长文本脚本拆成卡片,在画布中自由拖拽、连线、批注、整理素材,
6-
让脚本从「一大段文字」变成「可视化的内容结构」。
6+
面向编导、短视频创作者、写作者的可视化脚本工作台。
77

8-
在线体验:在线体验:[flow.yolin02.top](https://flow.yolin02.top)
8+
把长文本脚本拆成卡片、素材、时间轴和结构关系,在一个画布中完成脚本拆解、编排与重组。
9+
10+
[在线体验](https://flow.yolin02.top) · [功能特性](#功能特性) · [快速开始](#快速开始) · [部署](#部署) · [License](#license)
11+
12+
<br />
13+
14+
![React](https://img.shields.io/badge/React-19-20232a?style=flat-square&logo=react)
15+
![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178c6?style=flat-square&logo=typescript&logoColor=white)
16+
![Vite](https://img.shields.io/badge/Vite-6.x-646cff?style=flat-square&logo=vite&logoColor=white)
17+
![React Flow](https://img.shields.io/badge/React%20Flow-12.x-ff0072?style=flat-square)
18+
![License](https://img.shields.io/badge/License-Apache--2.0-blue?style=flat-square)
19+
</div>
20+
21+
<br />
22+
23+
## 预览
24+
25+
<img width="2152" height="1383" alt="ScriptFlow Preview" src="https://github.com/user-attachments/assets/f3ee50ec-0678-49cf-9fdd-93943eb9e3a6" />
26+
27+
## 简介
28+
29+
ScriptFlow 是一个将「脚本文本」和「可视化结构」结合起来的创作工具。
30+
31+
你可以在左侧编写完整脚本,在右侧把段落拆成卡片,通过连线、图片、表格、时间轴和模板整理创作逻辑。相比纯 Word、Markdown 或 Excel,ScriptFlow 更适合处理脚本中的结构关系、素材引用和非线性编排。
32+
33+
## 适用场景
934

10-
适合:
1135
- 短视频脚本拆解
1236
- 影视解说文案结构整理
13-
- 内容策划脑图
14-
- 文案段落切片
37+
- 内容策划和镜头逻辑梳理
38+
- 文案段落切片与重组
1539
- 图片素材与脚本文字对应
16-
- 编导替代 Excel / Word 做脚本排版
17-
18-
<img width="2152" height="1383" alt="image" src="https://github.com/user-attachments/assets/f3ee50ec-0678-49cf-9fdd-93943eb9e3a6" />
19-
40+
- 用可视化画布替代 Excel / Word 做脚本排版
2041

2142
## 功能特性
2243

23-
- 富文本写作:基于 Tiptap,支持标题、列表、引用、加粗、斜体等基础编辑能力。
24-
- 段落切片:可将选区或段落快速生成画布节点
25-
- 可视化画布:支持节点拖拽、缩放、框选、多选、连线、复制粘贴、对齐和分布。
26-
- 多类型节点:支持文本、图片、灵感、表格、时间轴等节点类型。
27-
- 节点模板:可将框选区域保存为模板,并在画布中再次插入。
28-
- 媒体库:支持图片上传、插入图片节点和资源管理
29-
- Markdown:支持 Markdown 导入与导出
30-
- 查找替换:支持正文查找、替换、全部替换和结果跳转。
31-
- 本地保存:使用浏览器本地存储保存工作区状态
32-
- 静态部署:构建后可部署到任意静态资源服务。
44+
- **富文本脚本编辑**:基于 Tiptap,支持标题、列表、引用、加粗、斜体等基础编辑能力。
45+
- **段落切片**:可将正文选区或段落快速生成画布节点
46+
- **可视化画布**:基于 React Flow,支持拖拽、缩放、框选、多选、连线、复制粘贴、对齐和分布。
47+
- **多类型节点**:支持文本、图片、灵感、表格、时间轴等节点类型。
48+
- **节点模板**:可将框选区域保存为模板,并在画布中再次插入。
49+
- **媒体库**:支持图片上传、图片节点插入和素材资源管理
50+
- **Markdown 导入导出**:支持 Markdown 文件导入与导出
51+
- **查找替换**:支持正文查找、替换、全部替换和结果跳转。
52+
- **本地优先存储**:使用 IndexedDB 保存工作区状态,无需后端即可运行
53+
- **静态部署**:构建后可部署到任意静态资源服务。
3354

3455
## 技术栈
3556

36-
- React 19
37-
- TypeScript
38-
- Vite
39-
- Tailwind CSS
40-
- Tiptap
41-
- React Flow / `@xyflow/react`
42-
- Lucide React
43-
- IndexedDB
57+
| 类型 | 技术 |
58+
| --- | --- |
59+
| 应用框架 | React 19 |
60+
| 开发语言 | TypeScript |
61+
| 构建工具 | Vite |
62+
| 样式 | Tailwind CSS |
63+
| 富文本编辑 | Tiptap |
64+
| 可视化画布 | React Flow / `@xyflow/react` |
65+
| 图标 | Lucide React |
66+
| 本地存储 | IndexedDB |
4467

4568
## 快速开始
4669

@@ -94,7 +117,7 @@ src/
94117
index.css # 全局样式
95118
```
96119

97-
## 构建部署
120+
## 部署
98121

99122
执行生产构建:
100123

@@ -108,19 +131,7 @@ npm run build
108131
dist/
109132
```
110133

111-
该项目是纯前端静态应用,部署时只需要发布 `dist/` 目录即可。可部署到 Nginx、GitHub Pages、Vercel、Netlify、Cloudflare Pages、对象存储或其他静态资源服务器。
112-
113-
## 为什么做 ScriptFlow?
114-
115-
传统脚本写作通常会遇到几个问题:
116-
117-
- Word / Markdown 适合写正文,但不适合整理镜头、素材和批注
118-
- Excel 可以排表格,但排版不直观,拖拽和结构关系很弱
119-
- 思维导图适合发散,但不适合承载完整脚本文本
120-
- 专业剪辑软件太重,不适合前期编导策划
121-
122-
ScriptFlow 想解决的是:
123-
让编导在写脚本时,就能把正文、素材、批注、结构关系放在同一个画布里。
134+
ScriptFlow 是纯前端静态应用,部署时只需要发布 `dist/` 目录。可以部署到 Nginx、GitHub Pages、Vercel、Netlify、Cloudflare Pages、对象存储或其他静态资源服务器。
124135

125136
## 本地数据
126137

@@ -139,4 +150,6 @@ ScriptFlow 默认将工作区数据保存在当前浏览器中,包括正文内
139150
- 当前项目不包含账号、登录、多人协作或云端同步。
140151
- 修改后建议至少执行 `npm run lint``npm run build`
141152

153+
## License
142154

155+
本项目基于 Apache License 2.0 开源,详情请查看 [LICENSE](./LICENSE)

0 commit comments

Comments
 (0)