Yosoro 开源项目教程

1. 项目介绍

Yosoro 是一个美观的 Markdown 笔记本桌面应用程序，支持云端同步和多种功能。它允许用户管理笔记、支持 LaTeX 数学公式和绘图、文件同步（包括 OneDrive）、图片上传（支持 GitHub、微博、SM.MS）、导出笔记为 Markdown、HTML 或 PDF 格式，以及发布文章（支持 Medium）。Yosoro 提供了两种主题：神秘的暗色主题和可爱的亮色主题。

2. 项目快速启动

安装依赖

首先，确保你已经安装了 Node.js 和 Yarn。然后，克隆项目并安装依赖：

git clone https://github.com/IceEnd/Yosoro.git
cd Yosoro
yarn install

开发环境配置

复制开发配置文件并进行编辑：

cp ./config/devconfig.example.json ./config/devconfig.json

编辑 ./config/devconfig.json 文件，添加 Chrome 扩展路径，例如：

{
  "extensions": [
    "/Users/xxx/Library/Application Support/Google/Chrome/Default/Extensions/lmhkpmbekcpmknklioeibfkpmmfibljd/2.15.3_0",
    "/Users/xxx/Library/Application Support/Google/Chrome/Default/Extensions/fmkadmapgofadopljbjfkapdkoienihi/3.4.0_0"
  ]
}

运行项目

运行主进程：

npm run dev:main

运行渲染进程：

npm run dev:renderer

构建项目

构建所有部分：

npm run build:all

构建主进程：

npm run build:main

构建渲染进程：

npm run build:renderer

打包项目

打包为 macOS 应用：

npm run packager:mac

打包为 Windows 应用：

npm run packager:win

打包为 64 位 Windows 应用：

npm run packager:win:64

打包为 Linux 应用：

npm run packager:linux

3. 应用案例和最佳实践

案例1：学术笔记管理

Yosoro 可以用于管理学术笔记，支持 LaTeX 数学公式和绘图功能，非常适合科研人员和学生使用。用户可以将笔记同步到 OneDrive，确保数据安全。

案例2：博客文章撰写

Yosoro 支持将笔记导出为 Markdown、HTML 或 PDF 格式，用户可以轻松撰写博客文章并发布到 Medium 等平台。

最佳实践

• 定期备份：使用 OneDrive 或其他云服务定期备份笔记，防止数据丢失。
• 主题切换：根据个人喜好切换暗色或亮色主题，提高使用体验。
• 图片管理：利用图片上传功能，将图片上传到 GitHub 或微博，方便笔记中的图片引用。

4. 典型生态项目

Electron

Yosoro 基于 Electron 框架开发，Electron 是一个使用 JavaScript、HTML 和 CSS 构建跨平台桌面应用程序的框架。

React

Yosoro 的前端使用 React 框架，React 是一个用于构建用户界面的 JavaScript 库。

Markdown

Yosoro 支持 Markdown 语法，Markdown 是一种轻量级标记语言，易于阅读和编写。

LaTeX

Yosoro 支持 LaTeX 数学公式，LaTeX 是一种基于 TeX 的排版系统，广泛用于学术界。

OneDrive

Yosoro 支持 OneDrive 文件同步，OneDrive 是微软提供的云存储服务。

通过这些生态项目的支持，Yosoro 提供了强大的功能和良好的用户体验。