Enhancement: Move emoji short code to separate plugin
维护者通常 2 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 38/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
- 领域
- tooling
调研方向
从 /src/core/render/emoji-data.js 开始，了解必须移出核心 bundle 的 emoji 短代码支持。然后跟踪现有的插件组织方式和构建输出；当一个官方插件提供短代码以及原生或 GitHub 风格的渲染、核心 bundle 不再包含该支持，并按提议完成精简时，即表示完成。
由索引模型根据 Issue 内容生成。
描述
👉 Note: This is a post-v5 feature request (see Milestone)
Feature request
- Remove emoji short code support from Docsify core bundle
- Create a new emoji official plugin:
- Provide short code support (e.g.,
:+1:= 👍) - Provides ability to render native emoji characters or GitHub-style emoji images
- Provide short code support (e.g.,
Proposal
Significantly reduce the file size of the core Docsify library by removing emoji short code support and instead offering it as an official plugin.
- Docsify with emoji short code support: 164KB (minified)
- Docsify without emoji short code support: 94KB (minified)
Removing short code support (/src/core/render/emoji-data.js) provides a 53% reduction in the minified Docsify.js bundle size.
An official Docsify emoji plugin would provide both short code support (e.g., :+1: = 👍) and the ability to render GitHub-style emoji images instead of OS-native emoji characters for those who want consistent emoji across all platforms (as Docsify v4 does today by default).
IMPORTANT: Removing short code support does not mean Docsify will be unable to render emoji without the plugin. This change only requires markdown authors to use their OS-native emoji picker to add emoji to their markdown documents instead of short codes. Those emoji will work as expected in Docsify, GitHub, and in other markdown applications, which arguably makes their markdown more portable since not all markdown environments support GitHub short codes.
For context...
Docsify's emoji short code support has been included in Docsify since v4 was released in 2017. This was a convenient way for those familiar with GitHub short codes to render emoji in their Docsify sites. More importantly, it was also the only way for Windows and Ubuntu users to easily add emoji to their Docsify and GitHub-flavored markdown because those operating systems lacked a native emoji picker:
- MacOS emoji picker: released ~2013
- Windows emoji picker: released ~2020
- Ubuntu emoji picker: released ~2018
Thankfully, all major operating systems now support native emoji pickers which are easily accessible via a keyboard shortcut:
- Mac: Command + Control + Spacebar
- Windows: Win + .
- Ubuntu: Control + .
These native emoji pickers reduce--but do not eliminate--the need for emoji short codes because users can now easily add native emoji characters to their markdown documents.
- 主要语言
- JavaScript
- 星标
- 31.5k
- 派生
- 5.8k
- 平均合并
- 2 天 14 小时
- 30 天内合并 PR
- 5
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
docsifyjs/docsify 的其他 Issue
-
Query parameter values are truncated at a second equals sign可能已有人在做 @xu91102 于 21 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 2 天内回复
-
bug Triage
难度 3/5 1-2 天 新手友好度 66/100
维护者通常 2 天内回复
-
Cached AJAX responses lose status metadata exposed through vm.route.response可能已有人在做 @xu91102 于 21 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 2 天内回复
-
In the Edge browser, the character `{docsify-updated}` is not replaced可能重新可做 @AmanUllah687 于 74 天前认领，目前没有进行中的 PR。 未关闭wait for information
难度 4/5 3-5 天 新手友好度 35/100
docsifyjs/docsify#2681 · 11 条评论 ·
维护者通常 2 天内回复
-
feature request Triage
难度 4/5 3-5 天 新手友好度 38/100
docsifyjs/docsify#2643 · 5 条评论 ·
维护者通常 2 天内回复
查看 docsifyjs/docsify 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
sallowayma-git/IELTS-practice#248 ·
维护者通常 1 天内回复
-
a11y data import fails with "missing --authors parameter" (npm drops flags in `bin/configure.js`)未关闭
难度 2/5 1-3 小时 新手友好度 90/100
-
难度 2/5 1-3 小时 新手友好度 74/100
Emanuele-web04/remodex#203 ·
维护者通常 1 天内回复
-
needs-human work-class: mechanical
难度 2/5 半天 新手友好度 84/100
melodic-software/claude-code-plugins#7994 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
keyxmakerx/Chronicle#1532 ·
维护者通常 1 天内回复