Joplin 插件清单新元数据指南：用 icons、categories、screenshots 与 promo

Joplin 插件清单新元数据指南用 icons、categories、screenshots 与 promo_tile 打造高质量插件展示页【免费下载链接】joplinJoplin - the privacy-focused note taking app with sync capabilities for Windows, macOS, Linux, Android and iOS.项目地址: https://gitcode.com/GitHub_Trending/jo/joplin本指南聚焦 Joplin 为插件 manifestmanifest.json新增的四类展示型元数据——icons、categories、screenshots与promo_tile它们在 Joplin 插件官方网站Joplin Plugins Website上直接决定插件被如何描述、筛选和呈现。读完本文你将掌握每个字段的数据结构、规格约束、源码层的解析逻辑以及一份可直接复制使用的完整 manifest 配置示例。背景插件清单Plugin Manifest是什么Joplin 的插件生态以manifest.json为入口描述文件它声明插件的 ID、名称、版本、兼容的最低应用版本等属性。如果你使用官方 Yeoman 生成器generator-joplin创建插件manifest 会自动生成。从 2024 年 1 月起见新闻公告manifest 新增了四个面向展示与发现能力的属性icons、categories、screenshots和promo_tile它们主要用于 Joplin 插件官网对插件进行更好的描述与呈现。一、Icon图标定义插件在官网各页面的视觉形象icons是插件在 Joplin 插件官网多个页面包括插件主页面和搜索结果页中使用的图标。如果未提供网站会显示一个默认图标。从类型定义看图标按像素尺寸提供多份 PNG 文件仓库中 types.ts 明确了支持的结构export interface Icons { 16?: string; 32?: string; 48?: string; 128?: string; }官方建议至少提供一个主图标理想尺寸为48×48其余尺寸16、32、128可选Joplin 会尝试在不同组件中找到最适合展示的图标。需要注意只允许 PNG 格式图标所有路径相对于仓库根目录。对应的解析逻辑位于 manifestFromObject.ts只要 16、32、48、128 任一尺寸存在即视为有效否则返回null走默认图标分支const getIcons (): Icons { if (!o.icons) return null; const icons o.icons as Icons; for (const size of [16, 32, 48, 128]) { if (icons[size as keyof Icons]) return icons; } return null; };二、Category分类让插件可被官网筛选categories允许你为插件提供一个或多个分类官网据此对插件进行筛选。其类型为string[]在 plugin_manifest 参考文档中给出了完整的分类表分类描述appearance与应用的某些元素外观相关例如行号、布局等developer tools面向开发者构建的工具editor增强笔记编辑器files处理文件例如导入、导出、备份等integrations集成第三方服务或应用personal knowledge management管理和组织笔记productivity让 Joplin 使用起来更高效search增强应用内搜索tags处理笔记标签themes改变应用主题viewer增强笔记的渲染在生成器模板 manifest.json 中categories默认以空数组[]存在开发者按需填入一个或多个分类即可。三、Screenshots截图在官网展示插件界面screenshots同样支持一个或多个截图用于在 Joplin 插件官网展示插件效果。每一项是一个 Image 对象包含两个属性属性描述src截图路径或 URL。若为路径则相对仓库根目录如screenshots/a.pnglabel图片描述供屏幕阅读器使用或在图片无法加载时显示重要约束若src是路径而非 URL那么repository_url或homepage_url必须指向一个 GitHub 仓库截图才能在 Joplin 插件官网上显示。从源码看manifestFromObject.ts 对screenshots采用宽松处理缺省时返回空数组const getScreenshots (defaultValue: Image[] []): Image[] { if (!o.screenshots) return defaultValue; return o.screenshots as Image[]; };仓库自带的真实示例 AbcSheetMusic 插件 manifest 中截图即通过相对路径images/PeacherineRag.png、images/Tablature.png引用仓库内的图片文件。下图是带有图标、分类和截图的插件页面示例四、Promo tile推广横幅官网首页的展示位promo_tile是可选的推广图片用于在 Joplin 插件官网首页展示插件。如果不提供 promo tile则会改用插件图标。官方对 promo tile 的规格要求如下属性描述src图片路径或 URL必须是440×280的 JPEG 或 PNG 图片不支持 alpha 透明通道若为路径则相对仓库根目录如images/promo_tile.pnglabel图片描述供屏幕阅读器使用或在图片无法加载时显示制作 promo tile 的良好起点是将插件图标或 Logo 与插件名称并排展示可参考 Chrome Web Store 中大量优质的推广横幅设计。源码侧 manifestFromObject.ts 的处理很直接promo_tile缺失时返回null即回退到图标const getPromoTile (): Image { return (o.promo_tile as Image) || null; };下图为 promo tile 在首页的展示示例五、完整 Manifest 示例一份可复制的配置综合以上字段官方文档 plugin_manifest 给出了一份完整的 manifest 示例{ manifest_version: 1, name: Joplin Simple Plugin, description: To test loading and running a plugin, version: 1.0.0, author: John Smith, app_min_version: 1.4, app_min_version_mobile: 3.0.3, platforms: [mobile, desktop], homepage_url: https://joplinapp.org, screenshots: [ { src: images/screenshot.png, label: An example of the plugin being used }, { src: https://example.com/images/screenshot.png, label: The plugin loading screen } ], icons: { 16: images/icon16.png, 32: images/icon32.png, 48: images/icon48.png, 128: images/icon128.png }, promo_tile: { src: images/promo_tile.png, label: A logo of a plugin on a clear background } }仓库测试数据中真实发布的 AbcSheetMusic manifest 则展示了生产环境中的写法包含category字段、三份关键词、两张截图、四个尺寸的图标以及一个 promo_tile并带有发布时自动写入的_publish_hash、_publish_commit、_npm_package_name等私有字段。六、源码侧的整体解析与校验流程在 manifestFromObject.ts 中整个 manifest 被统一解析为 types.ts 中定义的PluginManifest接口必填字段manifest_version、id、name、version、app_min_version缺失或类型错误会直接抛出Missing required field/Field must be a string等错误categories、screenshots、keywords等可选数组缺省时使用空数组默认值icons与promo_tile缺省时返回null由上层回退到默认图标逻辑解析完成后还会调用validatePluginId校验插件 ID、validatePluginPlatforms校验平台列表。对于使用 generator-joplin 脚手架创建的插件模板 manifest.json 已预留keywords、categories、screenshots、icons、promo_tile全部字段初始为空值开发者只需补充内容即可完成插件展示信息的配置。总结icons、categories、screenshots与promo_tile构成了 Joplin 插件在官网的完整视觉与发现体系图标与截图负责“看得见”分类负责“找得到”promo tile 负责“被推广”。配置时只需记住几个关键约束——PNG 图标与多尺寸建议、11 个受支持分类、截图路径依赖 GitHub 仓库地址、promo tile 严格为 440×280 的 JPEG/PNG无 alpha——即可让插件在官网上获得专业、完整的呈现。【免费下载链接】joplinJoplin - the privacy-focused note taking app with sync capabilities for Windows, macOS, Linux, Android and iOS.项目地址: https://gitcode.com/GitHub_Trending/jo/joplin创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考

Joplin 插件清单新元数据指南：用 icons、categories、screenshots 与 promo_tile 打造高质量插件展示页

相关推荐

TagStudio 中 FFmpeg 的安装指南：从三大平台安装到源码级集成解析

瑶浴行业口碑评价体系构建与消费者决策分析

如何用 douyin-downloader 批量下载抖音无水印视频，并按作者与日期自动归档

更多资讯

STC15单片机超声波测距OLED显示实战：从原理到原理图设计

C#对象映射实战：反射、特性与表达式树应用

半导体设备技术突破与智能化发展趋势

LTspice元器件库本质：路径、符号与模型三要素协同机制

EITtext_EIT：Python实现行内实体标签解析与转换实战

Qt+OpenCV+C++实战：从零构建行车辅助系统核心功能

今日更新

基于MATLAB的CRI显色指数计算：从SPD光谱到Ra的完整流程

JSP+Servlet+MySQL博客系统源码部署与优化全攻略

蜂窝调度算法 MATLAB 实现：比例公平、轮询与最大 C/I 对比

本周精选

AI驱动的自动化专利分析平台技术解析

LeetCode-Go 题解：1252. Cells with Odd Values in a Matrix（奇数值单元格计数）双解法剖析

在线答疑系统Java毕设实战：Spring Boot前后端分离与状态流转

本月热门

基于YOLO的焊缝缺陷检测：从数据标注到工业部署全流程实践

分布式服务的决策记录

创业产品的首版范围

读完文章，想聊聊您的网站？