Enhancement: Move emoji short code to separate plugin
Maintainer antworten meist innerhalb von 2 Tagen
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 38/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- javascript
- Bereich
- tooling
Rechercherichtung
Beginne mit /src/core/render/emoji-data.js, um die Unterstützung für Emoji-Kurzbezeichnungen zu verstehen, die aus dem Core-Bundle entfernt werden muss. Verfolge anschließend die bestehende Plugin-Organisation und den Build-Output; als abgeschlossen gilt die Arbeit, wenn ein offizielles Plugin Kurzbezeichnungen und natives oder GitHub-ähnliches Rendering bereitstellt, das Core-Bundle diese Unterstützung nicht mehr enthält und wie vorgeschlagen reduziert ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
👉 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.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 31.5k
- Forks
- 5.8k
- Ø Merge
- 2 T. 14 Std.
- Gemergte PRs (30 T.)
- 5
Entwicklungsumgebung
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus docsifyjs/docsify
-
Query parameter values are truncated at a second equals signEvtl. vergeben @xu91102 hat das vor 21 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 2 Tagen
-
bug Triage
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 66/100
Maintainer antworten meist innerhalb von 2 Tagen
-
Cached AJAX responses lose status metadata exposed through vm.route.responseEvtl. vergeben @xu91102 hat das vor 21 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
Maintainer antworten meist innerhalb von 2 Tagen
-
In the Edge browser, the character `{docsify-updated}` is not replacedEvtl. wieder frei @AmanUllah687 hat das vor 75 Tagen übernommen, und es ist kein Pull Request offen. Offenwait for information
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
docsifyjs/docsify#2681 · 11 Kommentare ·
Maintainer antworten meist innerhalb von 2 Tagen
-
feature request Triage
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 38/100
docsifyjs/docsify#2643 · 5 Kommentare ·
Maintainer antworten meist innerhalb von 2 Tagen
Alle Issues in docsifyjs/docsify
Ähnliche Issues
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
maproulette/maproulette-frontend#2944 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
jaegertracing/jaeger-ui#4618 ·
Maintainer antworten meist innerhalb von 1 Tag
-
area:plugins enhancement platform:vscode
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
anthropics/claude-code#103166 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Add: Kids Zone LogoOffencheck:failed logos:add
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
-
[workshop-sim] Improve: Add verifiable checkpoint and bridge to Step 5 (What Are Agentic Workflows?)Offenfeedback simulation workshop
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
githubnext/gh-aw-workshop#4715 ·
Maintainer antworten meist innerhalb von 1 Tag