#2431·docsify

改进: 将表情符号短码移至单独的插件

作者: jhildenbiddle创建于 2024年5月20日更新于 2025年11月23日
标签enhancementfeature request

** 说明:** 这是一个后 v5 特性请求( 见 Mileston)

□ 特性请求

  1. 从 Docsify 核心捆绑中删除emoji 短码支持
  2. 创建一个新的emoji官方插件:
  • 提供短代码支持(例如:`:+1' =:+1)
  • 提供制作原生的emoji字符或GitHub风格的emoji图像的能力

建议

大幅降低核心Docsify库的文件大小,方法是去掉emoji短代码支持,取而代之作为官方插件提供.

  • 以emoji短码支持文件:164KB(小)
  • 在无emoji短代码支持的情况下进行校正:94KB(最小)

删除短码支持( " /src/core/render/emoji-data.js " )可减少53%的已修改的Docsify.js捆绑大小。

一个正式的Docsify emoji插件既能提供短代码支持(如:":+1:" =:+1:"),又能为想要在所有平台上保持一致的emoji字符(如Docsify v4在默认情况下今天所做的那样)提供GitHub-风格的emoji图像.

** 重要 : ** 删除短代码支持 does * not * 表示 Docsify 没有插件将无法渲染出emoji 。 这一改变只要求被标记下作者使用他们的OS-native emoji采取器在他们的被标记下文档中加入emoji而不是短代码. 这些emoji将按Docsify、GitHub和其他降标应用程序的预期工作,这些应用程序可能使其降标更加便捷,因为并非所有降标环境都支持GitHub短码。

对于背景...

Docsify的emoji短码支持自2017年v4发布后便被包含在Docsify中. 对于那些熟悉GitHub短码的人来说,这是一种方便的方法,可以在其文件网址中制作emoji。 更为重要的是,这也是Windows和Ubuntu用户在他们的Docsify和GitHub-flavored标记下方便地添加emoji的唯一方法,因为这些操作系统缺乏本土的emoji取取出器:

  • MacOS emoji拾取器:发布~2013
  • Windows emoji采取器:发布~2020
  • Ubuntu emoji取取器:发布~2018

感谢所有主要操作系统都支持本地的emoji采取器,

这些本地的emoji拾取者减少-但不会消除-emoji短码的需求,因为用户现在可以轻松地将本地的emoji字符添加到他们的平分文档中.

内容来源: docsifyjs/docsify