76 lines
2.3 KiB
Markdown
76 lines
2.3 KiB
Markdown
|
# 需求文档格式说明
|
|||
|
|
|
|||
|
|
> 本目录支持 **Markdown（.md）** 格式，可在 Cursor 中直接粘贴图片并预览。
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 为什么用 Markdown
|
|||
|
|
|
|||
|
|
| 能力 | 说明 |
|
|||
|
|
|:-----------|:-------------------------------------------------|
|
|||
|
|
| 粘贴图片 | 配合扩展可 Ctrl+V / Cmd+V 直接粘贴剪贴板图片 |
|
|||
|
|
| 预览 | Cursor 内置 Markdown 预览，`Cmd+Shift+V` 即可 |
|
|||
|
|
| 版本管理 | 纯文本 + 图片文件，方便 Git 追踪 |
|
|||
|
|
| 跨平台 | 任意编辑器可编辑，导出 PDF/HTML 也方便 |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 使用方法
|
|||
|
|
|
|||
|
|
### 1. 新建文档
|
|||
|
|
|
|||
|
|
- 复制 `_模板_需求文档.md`，重命名为你的文档名（如 `20260308找伙伴功能.md`）
|
|||
|
|
- 或直接新建 `.md` 文件
|
|||
|
|
|
|||
|
|
### 2. 粘贴图片
|
|||
|
|
|
|||
|
|
**方式一：配合扩展（推荐）**
|
|||
|
|
|
|||
|
|
1. 在 Cursor 中安装扩展：`Paste Image` 或 `Markdown Paste`
|
|||
|
|
2. 截屏或复制图片到剪贴板
|
|||
|
|
3. 在 `.md` 文件中按 `Ctrl+V`（Mac：`Cmd+V`）
|
|||
|
|
4. 扩展会自动将图片保存到 `images/` 并插入 ``
|
|||
|
|
|
|||
|
|
**方式二：手动**
|
|||
|
|
|
|||
|
|
1. 将图片放入本目录下的 `images/` 文件夹
|
|||
|
|
2. 在文档中插入：``
|
|||
|
|
|
|||
|
|
### 3. 预览
|
|||
|
|
|
|||
|
|
- **快捷键**：`Cmd+Shift+V`（Mac）或 `Ctrl+Shift+V`（Windows）
|
|||
|
|
- **右键**：编辑器内右键 → 「Open Preview」
|
|||
|
|
- 卡若AI 规则已配置 Markdown Preview Enhanced，可直接查看排版
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 目录约定
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
修改/
|
|||
|
|
├── README_需求文档格式说明.md ← 本说明
|
|||
|
|
├── _模板_需求文档.md ← 可复制的模板
|
|||
|
|
├── images/ ← 粘贴的图片存放于此
|
|||
|
|
│ └── .gitkeep
|
|||
|
|
├── 20260308找伙伴功能.md ← 你的需求文档
|
|||
|
|
└── *.pdf / *.pages ← 仍可保留原格式作归档
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 扩展安装（如需粘贴图片）
|
|||
|
|
|
|||
|
|
在 Cursor 扩展市场搜索并安装其一：
|
|||
|
|
|
|||
|
|
- **Paste Image**：`naumovs.paste-image`
|
|||
|
|
- **Markdown Paste**：支持粘贴图片并生成 Markdown 引用
|
|||
|
|
|
|||
|
|
**Paste Image 路径配置**（可选）：在 `settings.json` 中添加，使图片保存到当前目录的 `images/` 下：
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"pasteImage.path": "${currentFileDir}/images",
|
|||
|
|
"pasteImage.basePath": "${currentFileDir}"
|
|||
|
|
}
|
|||
|
|
```
|