cheat-sheet-studio / README.md
duqing2026's picture
Initial commit
6730b1a
|
Raw
History Blame Contribute Delete
1.99 kB
---
title: 速查表工坊 (Cheat Sheet Studio)
emoji: 📝
colorFrom: blue
colorTo: indigo
sdk: docker
pinned: false
short_description: 专为开发者设计的可视化速查表生成器,支持Markdown和代码高亮。
app_port: 7860
---
# 速查表工坊 (Cheat Sheet Studio)
## 简介
速查表工坊 (Cheat Sheet Studio) 是一款专为开发者和知识创作者设计的可视化工具,帮助你快速制作漂亮、结构化的速查表(Cheat Sheet)。无论是编程语言语法、快捷键列表,还是备考知识点,都能通过简单的拖拽和编辑,生成高质量的图片。
## 功能亮点
- **可视化编辑**:所见即所得的卡片式编辑体验,支持实时预览。
- **智能排版**:基于 CSS Columns 的瀑布流(Masonry)自动布局,最大化利用版面空间。
- **多主题支持**:内置多种配色方案(GitHub, Dracula, Obsidian, Monokai 等),一键切换风格。
- **代码高亮**:集成 Prism.js,支持 Python, JavaScript, Shell, JSON 等常用语言语法高亮。
- **自定义配置**:自由调整列数(1-4列)、字体大小、背景颜色。
- **本地化存储**:所有数据自动保存到浏览器 LocalStorage,防止数据丢失。
- **高清导出**:基于 html2canvas 的高清 PNG 导出,适合社交媒体分享或打印。
## 使用方法
1. **添加内容**:点击左侧“添加文本卡片”或“添加代码卡片”。
2. **编辑卡片**:直接点击卡片上的标题或内容进行编辑。
3. **调整样式**:在侧边栏选择喜欢的主题颜色,调整列数布局。
4. **导出分享**:点击右上角“导出图片”按钮,生成你的速查表。
## 部署
本项目基于 Flask + Vue 3 开发,支持 Docker 容器化部署,可直接运行在 Hugging Face Spaces。
### 本地运行
```bash
pip install flask
python app.py
```
### Docker 运行
```bash
docker build -t cheat-sheet-studio .
docker run -p 7860:7860 cheat-sheet-studio
```