Skip to content

FAQ.md

Latest commit

 

History

History
445 lines (307 loc) · 11.2 KB

FAQ.md

File metadata and controls

445 lines (307 loc) · 11.2 KB

常见问题 (FAQ)

本文档回答 MarKing 使用过程中的常见问题。

📋 目录

安装相关

Q1: MarKing 支持哪些操作系统？

A: MarKing 当前版本 (v1.1.1) 支持：

  • Windows: Windows 10 (64-bit) 及以上版本

注意：macOS 和 Linux 版本正在测试中，敬请期待。

Q2: 如何安装 MarKing？

A: Windows 用户可选择以下安装方式：

MSI 安装器 (推荐):

  1. 下载 MarKing_1.1.1_x64_en-US.msi
  2. 双击运行安装器
  3. 按照向导完成安装

NSIS 安装器:

  1. 下载 MarKing_1.1.1_x64-setup.exe
  2. 双击运行安装器
  3. 按照向导完成安装

Q3: 安装需要多少磁盘空间？

A:

  • 安装包大小: 约 40MB
  • 安装后占用: 约 200MB
  • 建议预留: 至少 500MB (包含数据和缓存)

Q4: 可以安装便携版吗？

A: 当前版本暂不提供便携版，未来版本会考虑添加。

Q5: 应用数据存储在哪里？

A: Windows 下的数据存储位置：

  • C:\Users\用户名\AppData\Roaming\com.marking.app\
    • metadata.db - 数据库文件
    • logs\ - 日志文件
    • Vaults\ - 文档库
    • temp_mermaid\ - 临时文件

使用相关

Q6: 如何创建新文档？

A: 有多种方式创建新文档：

  1. 工具栏按钮: 点击工具栏的 + 按钮
  2. 快捷键: 按 Ctrl+N (Windows/Linux) 或 Cmd+N (macOS)
  3. 文件菜单: 文件 → 新建文档
  4. 右键菜单: 在文件树空白处右键 → 新建文档

Q7: 支持哪些 Markdown 语法？

A: MarKing 支持标准 Markdown 语法和常用扩展：

  • 基础语法: 标题、段落、列表、引用、代码、链接、图片
  • 扩展语法: 表格、任务列表、删除线、脚注
  • 高级功能: 数学公式(LaTeX)、Mermaid 图表、代码高亮

Q8: 如何插入图片？

A: 有多种方式插入图片：

  1. 拖拽: 直接拖拽图片文件到编辑器
  2. 粘贴: 截图后按 Ctrl+V 粘贴
  3. 语法: 手动输入 ![描述](图片路径)
  4. 工具栏: 点击工具栏的图片按钮

图片会自动保存到文档同目录的 assets 文件夹。

Q9: 如何使用代码片段？

A: MarKing 内置 70+ 代码片段：

  1. 输入触发词(如 table、code、task)
  2. 按 Tab 键展开
  3. 按 ? 键查看所有可用片段

常用片段：

  • table - 创建表格
  • code - 代码块
  • task - 任务列表
  • link - 链接
  • img - 图片

Q10: 如何切换预览主题？

A:

  1. 点击工具栏的"主题"按钮
  2. 从 12 种主题中选择
  3. 主题会立即应用到预览区

功能相关

Q11: 表格可视化编辑器如何使用？

A:

  1. 创建表格: 输入 table + Tab 或点击工具栏"表格"按钮
  2. 进入编辑: 将光标移入表格，自动显示可视化编辑器
  3. 编辑内容: 像 Excel 一样点击单元格编辑
  4. 操作行列: 使用工具栏添加/删除行列
  5. 退出编辑: 点击编辑器外部或按 Esc

Q12: 如何使用全局搜索？

A:

  1. 按 Ctrl+Shift+F 打开全局搜索
  2. 输入搜索关键词
  3. 查看搜索结果列表
  4. 点击结果跳转到对应文档

Q13: 如何使用大纲导航？

A:

  1. 点击左侧边栏的"大纲"标签
  2. 查看当前文档的标题结构
  3. 点击标题快速跳转
  4. 大纲会随编辑自动更新

Q14: 如何使用版本快照？

A:

  1. 编辑文档时自动创建快照
  2. 点击工具栏的"历史"按钮
  3. 查看历史版本列表
  4. 点击版本预览或恢复

Q15: 如何使用数据备份？

A:

  1. 点击"设置" → "备份"
  2. 选择备份范围(全部数据/仅文档/仅设置)
  3. 点击"立即备份"创建备份
  4. 备份文件保存在指定目录
  5. 需要时点击"恢复"选择备份文件

v1.1.1 新增：支持灵活选择备份范围，可以只备份文档或设置，节省空间和时间。

导出相关

Q16: 支持导出哪些格式？

A: MarKing 支持导出以下格式：

  • DOCX: Microsoft Word 文档
  • PDF: PDF 文档
  • HTML: 网页文件

Q17: 如何导出 DOCX？

A:

  1. 点击工具栏"导出"按钮
  2. 选择"DOCX"标签
  3. 选择模板(学术论文/商务报告/简约风格)
  4. 调整配置(页边距、字体、行距等)
  5. 点击"导出"按钮

Q18: 导出的 DOCX 可以编辑吗？

A: 可以。导出的 DOCX 是标准的 Word 文档，可以在 Microsoft Word、WPS 等软件中打开和编辑。

Q19: 导出时图片会包含吗？

A: 会。导出时会自动包含文档中的所有图片，无需手动处理。

Q20: 导出 PDF 时如何选择主题？

A:

  1. 在导出对话框选择"PDF"标签
  2. 在"主题"下拉菜单中选择
  3. 可以实时预览效果
  4. 选择满意的主题后导出

故障排查

Q21: 应用无法启动怎么办？

A: 请尝试以下步骤：

  1. 检查系统版本: 确认系统满足最低要求
  2. 重新安装: 卸载后重新安装
  3. 管理员权限: 以管理员身份运行(Windows)
  4. 查看日志: 检查应用数据目录的日志文件
  5. 报告问题: 如果问题持续，请在 GitHub 提交 Issue

Q22: 文件无法保存怎么办？

A: 可能的原因和解决方法：

  1. 磁盘空间不足: 清理磁盘空间
  2. 权限问题: 检查文件夹权限
  3. 文件被占用: 关闭其他程序
  4. 路径过长: 缩短文件路径

Q23: 预览不更新怎么办？

A:

  1. 点击工具栏的"刷新"按钮
  2. 或按 F5 刷新预览
  3. 如果问题持续，重启应用

Q24: 导出失败怎么办？

A:

  1. 检查文件名: 确保文件名合法
  2. 检查路径: 确保导出路径存在
  3. 检查权限: 确保有写入权限
  4. 检查空间: 确保磁盘空间充足
  5. 查看日志: 检查错误信息

Q25: 数据丢失了怎么办？

A:

  1. 检查回收站: 文件可能在回收站
  2. 恢复快照: 使用版本快照恢复
  3. 恢复备份: 使用备份文件恢复
  4. 检查数据库: 数据可能仍在数据库中

详见 故障排查指南

数据管理

Q26: 数据存储在哪里？

A: Windows 数据存储位置：

  • C:\Users\用户名\AppData\Roaming\com.marking.app\

包含数据库、日志、文档库等所有应用数据。

Q27: 如何迁移数据？

A:

  1. 关闭 MarKing
  2. 复制整个数据目录
  3. 在新设备上粘贴到相同位置
  4. 启动 MarKing

Q28: 如何清理缓存？

A:

  1. 关闭 MarKing
  2. 删除数据目录中的 cache 文件夹
  3. 重启 MarKing

Q29: 数据会上传到云端吗？

A: 不会。MarKing 是完全本地化的应用，所有数据都存储在本地，不会上传到任何服务器。

Q30: 如何导出所有数据？

A:

  1. 使用"备份"功能创建完整备份
  2. 或直接复制数据目录
  3. 备份文件包含所有文档和设置

性能相关

Q31: 应用启动很慢怎么办？

A:

  1. 清理缓存: 删除缓存文件
  2. 减少文档: 归档不常用的文档
  3. 关闭自启: 禁用开机自启动
  4. 更新版本: 使用最新版本

Q32: 编辑大文件很卡怎么办？

A:

  1. 拆分文件: 将大文件拆分成多个小文件
  2. 关闭预览: 临时关闭实时预览
  3. 简化格式: 减少复杂的格式和图片
  4. 增加内存: 如果可能，增加系统内存

Q33: 导出很慢怎么办？

A:

  1. 简化文档: 减少图片和复杂格式
  2. 关闭其他程序: 释放系统资源
  3. 等待完成: 大文件导出需要时间
  4. 分批导出: 将大文档拆分导出

其他问题

Q34: MarKing 是开源的吗？

A: MarKing 是专有软件，但代码在 GitHub 上公开。详见 LICENSE。

Q35: 是否支持多语言？

A: 是的。当前版本 (v1.1.1) 支持中文和英文双语切换，可在设置中一键切换。

Q36: 是否支持插件？

A: 当前版本不支持插件系统。这是未来的规划功能。

Q37: 是否支持云同步？

A: 当前版本不支持云同步。你可以使用第三方云盘同步数据目录。

Q38: 如何报告 Bug？

A:

  1. 访问 GitHub Issues
  2. 点击"New Issue"
  3. 选择"Bug 报告"模板
  4. 填写详细信息并提交

Q39: 如何提出功能建议？

A:

  1. 访问 GitHub Issues
  2. 点击"New Issue"
  3. 选择"功能请求"模板
  4. 描述你的建议并提交

Q40: 如何参与贡献？

A:

  1. 阅读 贡献指南
  2. Fork 仓库
  3. 提交 Pull Request
  4. 等待审查

获取更多帮助

如果你的问题没有在这里找到答案，可以通过以下方式获取帮助：

最后更新: 2026-03-06

希望这些回答能帮助你更好地使用 MarKing！如果有其他问题，欢迎随时提问。🙏

Q41: 如何使用 Mermaid 图表编写助手？

A:

  1. 在编辑器中输入 mermaid + Tab 创建图表代码块
  2. 或点击工具栏的"Mermaid"按钮
  3. 选择图表类型(流程图/时序图/甘特图等)
  4. 使用提供的语法提示和模板编写图表代码
  5. 预览区会实时渲染图表效果

支持的图表类型：

  • 流程图 (Flowchart)
  • 时序图 (Sequence Diagram)
  • 甘特图 (Gantt Chart)
  • 类图 (Class Diagram)
  • 状态图 (State Diagram)
  • 实体关系图 (ER Diagram)
  • 用户旅程图 (User Journey)
  • Git 图 (Git Graph)
  • 饼图 (Pie Chart)
  • 象限图 (Quadrant Chart)
  • 需求图 (Requirement Diagram)
  • C4 图 (C4 Diagram)
  • 思维导图 (Mindmap)
  • 时间线图 (Timeline)
  • ZenUML (Sequence Diagram)
  • Sankey 图 (Sankey Diagram)
  • XY 图表 (XY Chart)
  • 块状图 (Block Diagram)

Q42: 如何使用多库管理？

A:

  1. 点击左上角的库名称下拉菜单
  2. 选择"新建库"创建新的文档库
  3. 或选择已有的库进行切换
  4. 每个库的数据完全独立，互不影响

使用场景：

  • 工作文档和个人笔记分开管理
  • 不同项目使用不同的库
  • 按主题或类别组织文档

Q43: v1.1.1 有哪些新功能？

A: v1.1.1 主要更新：

新增功能:

  • Mermaid 图表编写助手 - 辅助编写复杂图表，提供语法提示和模板
  • 智能备份系统 2.0 - 支持灵活选择备份范围(全部/文档/设置)
  • 多库管理增强 - 数据库按库隔离，管理更清晰
  • 附件管理优化 - 统一的资源存储结构

功能改进:

  • 编辑器代码片段和列表功能优化
  • Markdown 工具扩展
  • 表格编辑器性能提升
  • 快照系统优化

Bug 修复:

  • 国际化切换问题修复
  • 剪贴板图片粘贴修复
  • Markdown 链接功能修复
  • 文件监测系统优化

详见 更新日志