Enhancement: Move emoji short code to separate plugin
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 38/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript
- 領域
- tooling
調査の方向性
/src/core/render/emoji-data.js から始めて、core bundle から削除する必要がある絵文字ショートコードのサポートを理解します。次に、既存のプラグイン構成とビルド出力を追跡します。公式プラグインがショートコードとネイティブまたは GitHub スタイルのレンダリングを提供し、core 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時間
- マージ済み PR（30日）
- 5
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン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 日以内に返信