-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Either enable emoji plugin or not #1726
Either enable emoji plugin or not #1726
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/EcPr6PCNf3SUVXVgFNStQKGnR6FN |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit a52946f:
|
Hello @ChoKaPeek ! Thanks for submitting this. I will circle back soon. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I like this change, but it is a breaking change. This would require us to:
- bump to v5
- create the new migration log we've been chatting about, and describe the step to migrate from the previous version to the new one
- there are a high number of people not using version numbers in script tags that load Docsify from script tag. We need to either
- keep the v4 docsify{.min}.js in the same place, and output a new v5 script to a new location in the output folder, that way people can opt into the new version
- or just let people's emojies break, and when they ask, we point them to migration log.
Ultimately, for health of the project, I think breaking emoji's is better for the long term, but I can understand if we go with the non-breaking approach.
Related is PR #1733 (prevent people from starting Docsify sites with version-less links)
Here's a shorter way to put it: I think people making stable sites by default (stable as in it works exactly how they tested it) is better as a default. People can use I've never written a web app where it automatically updates itself and publishes itself with new dependencies. In my opinion, that is a recipe for periodical breakage, and more periodical work (from years of experience). Do you write websites that auto-update themselves to latest in-range versions of dependencies? I can't imagine doing this for a client, being done with a job, and them coming back to me asking why their site is broken every so often. It's not a good idea. |
Agreed that both the use of the See #779 for proposals on rending emoji and the the use of the emoji plugin moving forward. Much of what you've outlined here is covered there. In the meantime, there are simple changes that can be made to the emoji parser to address many of the issues you've linked to here. I'm going to take look at what non-breaking changes can be made short-term, then I'll circle back. |
Summary
Disclaimer: All the issues I have referenced were directly affected by the placeholder function. I am not pushing for emoji parsing to be disabled by default, but there are big issues with the actual placeholder / three-way system. It might be nice to add the emoji plugin to the default html
__colon__
or:
"quick-and-dirty" fixes__colon__
to:
to stay compatible with most quick-and-dirty fixes out there.This does not seem to need a three-way gate. As long as the plugin is installed, emojis are enabled. Otherwise they aren't. Saves time, avoids confusion and configuration, skips some computation.
If I am not wasting my time, ping me so I can fix tests.
What kind of change does this PR introduce?
Feature
For any code change,
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
Related issue, if any:
#1721
#1380
#853
#742
and so on
Tested in the following browsers: