Skip to content

Avoiding emoji transform of colons using __colon__ is undocumented and buggy #1380

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
1 task done
atuttle opened this issue Oct 2, 2020 · 2 comments · Fixed by #1381
Closed
1 task done

Avoiding emoji transform of colons using __colon__ is undocumented and buggy #1380

atuttle opened this issue Oct 2, 2020 · 2 comments · Fixed by #1381
Assignees
Labels
docs related to the documentation of docsify itself

Comments

@atuttle
Copy link

atuttle commented Oct 2, 2020

Bug Report

Today I saw in #742 that supposedly you can use __colon__ to insert colons that won't be used to transform into an emoji, as when e.g. :smile: would become 😄 .

Firstly, if this is intended to be a supported work-around, it should be documented. It is not mentioned at all in the docsify documentation. Secondly, it is not working correctly.

Steps to reproduce

$ echo '# foo:bar:baz\nfoo bar baz!\n\n\n# foo__colon__bar__colon__baz\nhere we go again' > src/test.md
$ docsify serve src
$ open http://localhost:3000/#/test

What is current behaviour

https://codesandbox.io/s/wizardly-noyce-44rr6?file=/README.md

Note that the first example displays correctly in the sidebar but incorrectly in the content, and the second example displays incorrectly in the sidebar but correctly in the content. 🤦

image

What is the expected behaviour

If __colon__ is the preferred way of avoiding the emoji transform, it should be rendered as a : in both the sidebar and the content consistently.

As I was typing up this bug report I thought to try : and that does seem to work. You might want to consider adopting that as the preferred approach. I included it in my code sandbox.

Other relevant information

  • Bug does still occur when all/other plugins are disabled?

  • Your OS: Mac OSX 10.14.5

  • Node.js version: 14.10.1

  • npm/yarn version: 6.14.8

  • Browser version: N/A

  • Docsify version: 4.4.1 (I see more recent versions on github, but none later than 4.4.1 published to npm)

  • Docsify plugins: none

Please create a reproducible sandbox

https://codesandbox.io/s/wizardly-noyce-44rr6?file=/README.md

Mention the docsify version in which this bug was not present (if any)

n/a only tried latest from npm

@sy-records sy-records self-assigned this Oct 2, 2020
@sy-records sy-records added the docs related to the documentation of docsify itself label Oct 2, 2020
@sy-records
Copy link
Member

sy-records commented Oct 2, 2020

Just install the plugin to solve your problem! https://docsify.js.org/#/plugins?id=emoji

@sy-records sy-records mentioned this issue Oct 2, 2020
19 tasks
@atuttle
Copy link
Author

atuttle commented Oct 2, 2020

That does seem to work, thank you.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs related to the documentation of docsify itself
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants