菜单

主要功能

相关源文件

本文档全面概述了 Joplin 在所有平台上的主要功能。Joplin 是一款功能丰富的笔记应用程序,旨在提供安全性、灵活性和跨平台功能。有关系统架构的信息,请参阅 系统架构

1. 核心功能

Joplin 提供了一套强大的笔记管理功能,构成了该应用程序的基础。

  • 笔记:创建、编辑和整理文本笔记,支持富文本格式。
  • 笔记本(文件夹):将笔记组织成层级结构。
  • 标签:为笔记添加多个标签,实现灵活的分类。
  • 资源(附件):在笔记中嵌入图片、文档和其他文件。
  • 待办事项列表:创建笔记作为待办事项,并跟踪截止日期和完成状态。
  • 全文搜索:使用高级查询语法跨笔记、标签和笔记本进行搜索。

笔记组织和数据模型

来源

2. 笔记编辑和格式化

Joplin 支持多种编辑选项,以适应不同的用户偏好和工作流程。

2.1 编辑器选项

  • 富文本编辑器(所见即所得):基于 TinyMCE 的编辑器,带格式工具栏。
  • Markdown 编辑器:基于 CodeMirror 的编辑器,支持语法高亮。
  • 纯文本编辑器:简单的文本编辑,无格式。
  • 外部编辑器支持:可在任何外部文本编辑器中编辑笔记。

通过切换按钮,可在富文本(所见即所得)和代码视图模式之间切换编辑器。

2.2 格式化功能

  • Markdown:全面支持标准 Markdown 语法。
  • 表格:创建和格式化结构化表格。
  • 数学公式:使用 KaTeX 渲染数学公式。
  • 代码块:支持多种编程语言的语法高亮。
  • 图表:使用 Mermaid 语法创建图表。
  • 复选框:用于任务列表的交互式复选框。
  • 自定义 CSS:为笔记应用自定义样式。

笔记编辑和渲染管线

来源

3. 同步

Joplin 提供强大的同步系统,以在所有设备上保持笔记的一致性。

3.1 同步目标

Joplin 支持多种同步目标。

  • Joplin Cloud:官方托管服务,提供额外的共享功能。
  • Joplin Server:自托管选项,功能与 Joplin Cloud 类似。
  • Nextcloud/WebDAV:与 Nextcloud 或任何兼容 WebDAV 的服务器同步。
  • Dropbox:与 Dropbox 存储同步。
  • OneDrive:与 Microsoft OneDrive 同步。
  • Amazon S3:与 Amazon S3 或兼容的存储同步。
  • 文件系统:与本地或网络文件系统同步。

3.2 同步功能

  • 端到端加密 (E2EE):所有数据在同步前都在本地加密。
  • 离线优先设计:所有数据都存储在本地,无需互联网连接即可访问。
  • 选择性同步:控制附件的下载方式和时间。
  • 冲突解决:通过冲突笔记本自动处理冲突更改。

同步架构

来源

4. 安全和隐私

4.1 端到端加密

Joplin 实现了强大的安全功能来保护您的数据。

  • 主密钥加密:笔记和资源使用主密钥进行加密。
  • 公私钥加密:支持用于共享的非对称加密。
  • 本地处理:所有加密和解密都在您的设备上进行。
  • 加密同步:所有数据在同步前都会被加密。

4.2 隐私功能

  • 离线优先:无需账户,所有数据都存储在本地。
  • 自托管选项:运行您自己的 Joplin Server,实现完全控制。
  • 无追踪:没有遥测或用户追踪。

来源

5. 跨平台支持

Joplin 在多个平台上可用,并提供一致的功能。

  • 桌面端:Windows、macOS 和 Linux 应用程序,基于 Electron 构建。
  • 移动端:Android 和 iOS 应用程序,基于 React Native 构建。
  • 终端:适用于 Linux、macOS 和 Windows 的命令行应用程序。
  • Web Clipper:用于 Firefox 和 Chrome 的浏览器扩展,用于保存网页。

跨平台架构

来源

6. 资源管理

Joplin 提供对各类附件的全面支持。

  • 文件附件:将任何类型的文件附加到笔记。
  • 图片:嵌入和调整笔记中的图片大小。
  • PDF 查看:内置 PDF 附件查看器。
  • 媒体播放:支持媒体文件的音频和视频播放。
  • 下载模式:配置附件的下载方式(始终、手动或自动)。
  • OCR 支持:图像的光学字符识别(支持的设备上)。

来源

7. 共享与协作

使用 Joplin Server 或 Joplin Cloud,您可以共享笔记并进行协作。

  • 笔记共享:与他人共享单个笔记。
  • 笔记本共享:与他人共享整个笔记本,可配置权限。
  • 公开链接:创建笔记的公开链接,供任何人查看。
  • 协作:与他人共同编辑共享的笔记。

共享架构

来源

8. 可扩展性和自定义

8.1 插件系统

Joplin 包含强大的插件系统,支持广泛的自定义。

  • 插件 API:用于创建插件的全面 API。
  • 内容脚本:扩展渲染能力。
  • UI 扩展:添加新的 UI 元素和视图。
  • 设置面板:向应用程序添加自定义设置。
  • 命令:定义新命令和键盘快捷键。

8.2 自定义选项

  • 主题:可选择内置主题(浅色、深色、Dracula、Solarized、Nord 等)。
  • 自定义 CSS:为应用程序和笔记应用自定义样式。
  • 键盘快捷键:自定义常用操作的键盘快捷键。
  • 笔记模板:为不同类型的笔记创建模板。

来源

9. Web Clipper

Web Clipper 浏览器扩展允许您将网络内容直接保存到 Joplin。

  • 整页剪辑:保存整个网页。
  • 简化剪辑:保存格式简化的网页。
  • 截图剪辑:保存网页的截图。
  • 选择剪辑:保存网页的选定部分。
  • 自定义格式:将自定义格式规则应用于剪辑内容。

来源

10. 搜索功能

Joplin 提供强大的搜索功能。

  • 全文搜索:跨所有笔记(包括附件)进行搜索。
  • 搜索语法:支持高级搜索运算符和语法。
  • 搜索过滤器:按笔记本、标签和其他属性过滤。
  • 已保存搜索:保存并重用常见的搜索查询。
  • 搜索高亮:高亮显示笔记中的搜索匹配项。

来源

核心组件集成

来源

本概述涵盖了 Joplin 在所有平台上的主要功能。有关更具体的实现细节,请参阅 Wiki 中的相应部分。