Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Enhancement: Move emoji short code to separate plugin

Aperta
  • Qualcosa non va?
#2,431 11 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
38/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
tooling

Direzione di ricerca

Inizia da /src/core/render/emoji-data.js per comprendere il supporto ai codici brevi delle emoji che deve essere rimosso dal bundle core. Poi segui l’organizzazione esistente dei plugin e l’output della build; il lavoro è completo quando un plugin ufficiale fornisce i codici brevi e il rendering nativo o in stile GitHub, il bundle core non include più quel supporto ed è ridotto come proposto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
JavaScript
Stelle
31.5k
Fork
5.8k
Merge medio
2g 14h
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di docsifyjs/docsify

Tutte le issue di docsifyjs/docsify

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.