Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Enhancement: Move emoji short code to separate plugin

Đang mở
  • Có gì không ổn?
#2,431 11 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
38/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu với /src/core/render/emoji-data.js để hiểu hỗ trợ mã ngắn emoji phải được loại bỏ khỏi core bundle. Sau đó lần theo cách tổ chức plugin hiện có và đầu ra build; công việc được xem là hoàn tất khi một plugin chính thức cung cấp mã ngắn và khả năng render native hoặc theo kiểu GitHub, core bundle không còn bao gồm phần hỗ trợ đó và được giảm xuống như đề xuất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement feature request

👉 Note: This is a post-v5 feature request (see Milestone)

Feature request

  1. Remove emoji short code support from Docsify core bundle
  2. 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
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.

Ngôn ngữ chính
JavaScript
Star
31.5k
Fork
5.8k
Merge trung bình
2 ngày 14 giờ
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của docsifyjs/docsify

Tất cả issue của docsifyjs/docsify

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.