Joplin Rich Markdown 项目使用教程

Joplin Rich Markdown 项目使用教程

joplin-rich-markdown Helping you ditch the markdown viewer for good. 项目地址: https://gitcode.com/gh_mirrors/jo/joplin-rich-markdown

1. 项目目录结构及介绍

Joplin Rich Markdown 插件旨在为 Joplin 编辑器提供更丰富的Markdown编辑体验。以下是项目的目录结构及其简要介绍：

• api/: 包含了与 Joplin 编辑器交互的 API 相关代码。
• examples/: 存放了一些使用 Rich Markdown 插件的示例文件。
• icons/: 存放插件所需的图标文件。
• src/: 插件的主要源代码目录，包含了插件的所有功能实现。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmignore: 指定 npm 包含和忽略的文件。
• GENERATOR_DOC.md: 生成文档的脚本或说明文件。
• LICENSE: 项目的 MIT 许可证文件。
• README.md: 项目说明文件。
• TIPS.md: 提供了一些 CSS 样式化的技巧。
• jest.config.js: Jest 测试框架的配置文件。
• package-lock.json: npm 包版本锁定文件。
• package.json: npm 包的配置文件。
• plugin.config.json: 插件配置文件。
• shell.nix: Nix 包管理器的配置文件。
• tsconfig.json: TypeScript 配置文件。
• webpack.config.js: Webpack 打包工具的配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 Joplin 插件管理器完成的。用户需要在 Joplin 应用中通过以下步骤安装插件：

1. 打开 Joplin，选择 工具 -> 选项 -> 插件。
2. 在插件搜索框中输入 "Rich Markdown"。
3. 点击 "安装"，安装成功后重启 Joplin。

插件安装后，会自动加载，无需手动启动。

3. 项目的配置文件介绍

插件的配置文件是 plugin.config.json，该文件包含了插件的配置选项。用户可以通过 Joplin 的设置菜单来修改这些配置：

• 在 Joplin 中选择 工具 -> 选项 -> Rich Markdown。
• 在这里可以启用或禁用插件的各种功能，例如图片预览、列表对齐等。

配置文件中的选项包括但不限于：

• imagesOnHover: 是否启用悬停时显示图片预览。
• imagesInEditor: 是否在编辑器中直接显示图片。
• checkbox: 是否启用复选框交互。
• links: 是否启用链接点击功能。
• highlighting: 是否启用文本高亮显示功能。

用户可以根据自己的需求调整这些设置，以获得更好的编辑体验。

joplin-rich-markdown Helping you ditch the markdown viewer for good. 项目地址: https://gitcode.com/gh_mirrors/jo/joplin-rich-markdown