Joplin 插件快速链接项目的启动和配置文档

1. 项目的目录结构及介绍

Joplin 插件快速链接项目的目录结构如下：

• api: 包含与 Joplin 插件交互的 API 相关文件。
• src: 源代码目录，包含插件的主体逻辑。
  • index.ts: 插件的入口文件，这里是 TypeScript 文件，负责初始化插件。
  • manifest.json: 插件的配置文件，定义了插件的基本信息和配置。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmignore: 指定 npm 包发布时忽略的文件和目录。
• GENERATOR_DOC.md: 可能是生成文档的脚本或说明文件。
• LICENSE.md: 项目的许可证文件。
• README.md: 项目的说明文件，用于介绍插件的功能和使用方法。
• package-lock.json: npm 依赖的锁定文件，确保在不同环境下安装的依赖一致。
• package.json: 定义了项目的依赖关系、脚本和元数据。
• plugin.config.json: 可能包含插件的配置信息。
• tsconfig.json: TypeScript 的配置文件。
• webpack.config.js: Webpack 的配置文件，用于构建项目。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。这个文件是 TypeScript 编写的，它是插件的入口点。在这个文件中，开发者会初始化插件，并设置插件的主要功能。例如，它会监听特定的用户输入，如 @@，并在Markdown编辑器中提供一个下拉菜单来选择链接到其他笔记。

3. 项目的配置文件介绍

项目的配置文件是 src/manifest.json。这个文件包含了插件的基本信息，例如插件的名称、版本、描述以及作者的联系方式。此外，它还定义了插件的一些行为和权限，例如它可以访问哪些Joplin的功能和数据。

以下是 manifest.json 的一个基本示例：

{
  "name": "Quick Links Plugin",
  "version": "1.0.0",
  "description": "A plugin for Joplin to quickly add links to other notes.",
  "author": "Roman R. M.",
  " permissions": [
    "access_FS",
    "write_FS"
  ]
}

这个配置文件是插件能够正确地在 Joplin 中注册和运行的关键。开发者需要确保所有必要的信息都已经填写，并且根据需要调整权限设置。