NoteGen 跨平台Markdown笔记应用技术文档

1. 安装指南

系统要求

• Windows 7及以上版本（64位）
• macOS 10.13及以上版本
• Linux（主流发行版）

下载方式

1. 访问项目发布页面获取最新安装包
2. 根据操作系统选择对应版本：
   • Windows: .exe安装包
   • macOS: .dmg镜像文件
   • Linux: .AppImage或.deb包

安装步骤

Windows系统：

1. 双击下载的.exe文件
2. 按照安装向导提示完成安装
3. 安装完成后可从开始菜单启动应用

macOS系统：

1. 打开下载的.dmg文件
2. 将应用图标拖拽到Applications文件夹
3. 首次运行时需在系统偏好设置中授权

Linux系统：

# 对于.deb包
sudo dpkg -i note-gen_x.x.x_amd64.deb
# 对于.AppImage
chmod +x NoteGen-x.x.x.AppImage
./NoteGen-x.x.x.AppImage

2. 项目使用说明

核心功能模块

1. 记录模块：

   • 支持文本、截图、文件等多种记录方式
   • 提供标签分类和AI辅助整理功能
   • 内置剪贴板助手自动识别内容

2. 写作模块：

   • 三合一编辑器（所见即所得/即时渲染/分屏预览）
   • 支持Markdown标准语法及扩展语法
   • 内置版本控制与历史回滚

3. 文件管理：

   • 本地文件与云端同步文件统一管理
   • 无限层级目录结构
   • 多条件排序与全局搜索

基础工作流程

1. 通过记录模块收集碎片化内容
2. 使用AI辅助将记录整理为结构化笔记
3. 在写作模块中进行深度编辑
4. 通过同步功能实现多设备数据共享

3. 项目API使用文档

核心API接口

// 记录相关API
interface RecordingAPI {
  createRecording(content: string, type: 'text'|'image'|'file'): Promise<Recording>
  getRecordings(filter?: {tags?: string[]}): Promise<Recording[]>
  aiOrganize(recordingIds: string[], prompt?: string): Promise<string>
}

// 文件管理API
interface FileAPI {
  createFile(path: string, content?: string): Promise<FileItem>
  readFile(fileId: string): Promise<string>
  listDirectory(path?: string): Promise<FileItem[]>
}

// AI功能API
interface AIAPI {
  chat(messages: ChatMessage[], context?: NoteContext): Promise<string>
  enhance(text: string, operation: 'polish'|'translate'|'continue'): Promise<string>
}

// 同步API
interface SyncAPI {
  setupGitHubSync(config: GitHubConfig): Promise<void>
  setupWebDAVSync(config: WebDAVConfig): Promise<void>
  manualSync(): Promise<SyncResult>
}

扩展插件开发

1. AI模型集成：

registerAIModel({
  id: 'custom-model',
  name: 'My Custom Model',
  endpoints: [{
    type: 'chat',
    url: 'https://api.example.com/chat'
  }],
  configSchema: {
    apiKey: {type: 'string', required: true}
  }
})

2. 主题定制：

/* 自定义主题示例 */
:root {
  --primary-color: #528bff;
  --editor-font-family: 'JetBrains Mono', monospace;
}

4. 项目安装方式详解

标准安装

1. 从官方渠道下载对应平台的安装包
2. 按照系统常规方式安装
3. 首次运行会引导进行基础配置

开发者模式

1. 克隆仓库：

git clone https://github.com/codexu/note-gen.git

2. 安装依赖：

cd note-gen
npm install

3. 开发运行：

npm run tauri dev

容器化部署

# Dockerfile示例
FROM node:18
WORKDIR /app
COPY . .
RUN npm install && npm run build
CMD ["npm", "run", "tauri", "build"]

移动端注意事项

• Android：需开启未知来源安装权限
• iOS：目前仅支持自行编译安装
• 建议通过官方应用商店获取移动端版本