Joplin Outline 插件技术文档

Joplin Outline 插件技术文档

joplin-outline 项目地址: https://gitcode.com/gh_mirrors/jo/joplin-outline

安装指南

系统要求

• Joplin 1.3.15 或更高版本，以支持应用程序插件。

安装步骤

1. 下载最新版本的 outline.jpl 文件。
2. 将 outline.jpl 文件复制到 Joplin 的 plugins 目录中。
3. 重启 Joplin 应用程序，插件将自动加载并执行。

项目使用说明

功能概述

• 支持 atx-style 标题（#），不支持 setext-style 标题（---, ===）。
• 支持右键点击粘贴 Markdown 内部链接。
• 支持可折叠的大纲。
• 支持自动编号。
• 支持自定义样式。
• 支持在标题前添加自定义符号。
• 支持在编辑模式下跳转到标题。

使用方法

1. 打开 Joplin 应用程序。
2. 在编辑或查看 Markdown 文档时，插件会自动生成大纲。
3. 通过右键点击大纲中的标题，可以粘贴 Markdown 内部链接。
4. 点击大纲中的标题，可以在编辑模式下跳转到相应位置。

项目API使用文档

自定义面板样式

• 用户可以通过修改插件的样式文件来自定义大纲面板的外观。
• 具体步骤请参考项目 Wiki 中的 Custom panel style 页面。

项目安装方式

手动安装

1. 下载 outline.jpl 文件。
2. 将文件复制到 Joplin 的 plugins 目录中。
3. 重启 Joplin 应用程序。

构建插件

1. 克隆项目代码库。
2. 运行 npm install 安装依赖。
3. 运行 npm run dist 构建插件。
4. 生成的 outline.jpl 文件位于项目根目录。

更新插件框架

1. 运行 yo joplin --update 更新插件框架。
2. 注意：更新操作会覆盖所有框架相关的文件（src/ 目录外的文件），请确保代码已进行版本控制。

社区支持

• 在 Joplin 论坛中，可以找到关于该插件的讨论和支持。
• 相关讨论主题包括：
  • A markdown outline sidebar plugin for Joplin
  • Toc as the sidebar

贡献者

• 感谢所有为该项目做出贡献的开发者。
• 贡献者列表可以在项目的 GitHub 页面上查看。

joplin-outline 项目地址: https://gitcode.com/gh_mirrors/jo/joplin-outline