Yank Note 安装和配置指南

Yank Note 安装和配置指南

yn A highly extensible Markdown editor. Version control, AI completion, mind map, documents encryption, code snippet running, integrated terminal, chart embedding, HTML applets, Reveal.js, plug-in, and macro replacement. 项目地址: https://gitcode.com/gh_mirrors/yn/yn

1. 项目基础介绍和主要编程语言

项目介绍

Yank Note 是一个高度可扩展的 Markdown 编辑器，专为提高生产力而设计。它支持版本控制、AI 助手、思维导图、文档加密、代码片段运行、集成终端、图表嵌入、HTML 小部件、Reveal.js 插件和宏替换等功能。

主要编程语言

Yank Note 主要使用以下编程语言和框架：

• TypeScript: 用于核心逻辑和插件开发。
• Vue.js: 用于前端界面开发。
• JavaScript: 用于部分功能实现。
• HTML/CSS: 用于页面布局和样式设计。

2. 项目使用的关键技术和框架

关键技术和框架

• Electron: 用于构建跨平台的桌面应用程序。
• Monaco Editor: 提供类似 VSCode 的编辑体验。
• Reveal.js: 用于创建演示文稿。
• PlantUML/Drawio/ECharts/Mermaid: 用于嵌入图表和图形。
• OpenAI: 用于 AI 自动补全功能。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. Node.js: 确保已安装 Node.js（建议版本 14.x 或更高）。
2. Git: 用于克隆项目代码。
3. Yarn: 用于管理项目依赖（可选，可以使用 npm 替代）。

详细安装步骤

步骤 1: 克隆项目代码

首先，打开终端并运行以下命令克隆项目代码：

git clone https://github.com/purocean/yn.git

步骤 2: 进入项目目录

进入克隆下来的项目目录：

cd yn

步骤 3: 安装依赖

使用 Yarn 或 npm 安装项目依赖：

yarn install

或

npm install

步骤 4: 运行项目

安装完成后，运行以下命令启动项目：

yarn start

或

npm start

步骤 5: 构建项目（可选）

如果你想构建项目以生成可执行文件，可以运行以下命令：

yarn build

或

npm run build

配置指南

Yank Note 的配置文件位于项目根目录下的 config 文件夹中。你可以根据需要修改这些配置文件来定制编辑器的行为。

示例配置

{
  "editor": {
    "theme": "dark",
    "fontSize": 14
  },
  "openai": {
    "apiKey": "your-openai-api-key"
  }
}

常见问题

• 依赖安装失败: 确保 Node.js 和 npm/yarn 版本符合要求，并尝试重新安装依赖。
• 运行失败: 检查终端输出以获取详细的错误信息，并根据错误提示进行修复。

通过以上步骤，你应该能够成功安装并运行 Yank Note 编辑器。如果有任何问题，请参考项目的 GitHub 页面或社区论坛获取帮助。

yn A highly extensible Markdown editor. Version control, AI completion, mind map, documents encryption, code snippet running, integrated terminal, chart embedding, HTML applets, Reveal.js, plug-in, and macro replacement. 项目地址: https://gitcode.com/gh_mirrors/yn/yn