Joplin Outline 插件下载及安装教程

Joplin Outline 插件下载及安装教程

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

1. 项目介绍

Joplin Outline 是一个为 Joplin 笔记应用开发的 Markdown 大纲（TOC）侧边栏插件。该插件支持 atx 风格的标题（#），不支持 setext 风格的标题（---, ===）。它还支持右键粘贴 Markdown 内部链接、可折叠的大纲、自动编号、自定义样式以及在编辑模式下跳转到标题等功能。

2. 项目下载位置

要下载 Joplin Outline 插件，请访问项目的 GitHub 仓库。你可以通过以下步骤下载项目：

1. 打开终端或命令行工具。

2. 使用 git clone 命令下载项目：

   git clone https://github.com/cqroot/joplin-outline.git
   

3. 项目安装环境配置

在安装 Joplin Outline 插件之前，请确保你的系统满足以下要求：

• Joplin 1.3.15 或更高版本（支持应用程序插件）
• Node.js 和 npm（用于构建插件）

环境配置示例

以下是配置环境的步骤：

1. 安装 Node.js 和 npm：

   • 访问 Node.js 官方网站 下载并安装 Node.js。

   • 安装完成后，打开终端并运行以下命令以验证安装：

     node -v
     npm -v
     

   • 你应该会看到类似以下的输出，表示 Node.js 和 npm 已成功安装：

     v14.17.0
     6.14.13
     

2. 安装 Joplin：

   • 访问 Joplin 官方网站 下载并安装 Joplin。

环境配置图片示例

4. 项目安装方式

安装 Joplin Outline 插件的步骤如下：

1. 下载插件：

   按照第2部分中的步骤，使用 git clone 命令下载项目。

2. 构建插件：

   进入项目目录并运行以下命令以构建插件：

   cd joplin-outline
   npm install
   npm run dist
   

3. 安装插件：

   构建完成后，将生成的 outline.jpl 文件复制到 Joplin 的插件目录中。通常，该目录位于 ~/.config/joplin-desktop/plugins/ 或 ~/.config/joplin-cli/plugins/，具体路径取决于你的操作系统。

4. 重启 Joplin：

   重启 Joplin 应用程序，插件将自动加载并执行。

5. 项目处理脚本

Joplin Outline 插件使用 Webpack 进行构建，生成的编译代码位于 /dist 目录中。以下是一些常用的处理脚本：

• 构建插件：

  npm run dist
  

• 更新插件框架：

  yo joplin --update
  

  注意：更新插件框架会覆盖所有框架相关的文件（位于 src/ 目录之外），因此请确保你的代码已进行版本控制，以便在更新后恢复你的更改。

通过以上步骤，你可以成功下载、安装并配置 Joplin Outline 插件，享受其提供的丰富功能。

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