Skip to content
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

Desktop: Resolves #9450: Make the beta markdown editor the default #10796

Merged

Conversation

personalizedrefrigerator
Copy link
Collaborator

@personalizedrefrigerator personalizedrefrigerator commented Jul 29, 2024

Summary

This pull request moves the CodeMirror 6-based markdown editor out of beta on desktop.

Related #9450, #10795.

Handling incompatible plugins

Currently, the following plugins are marked as incompatible or mostly incompatible with CodeMirror 6, though there may be others:

  • com.septemberhx.Joplin.Enhancement
    • Most features are incompatible with the CodeMirror 6-based editor.
  • ylc395.noteLinkSystem
  • outline
    • Jump to header may not work.
  • joplin.plugin.cmoptions
  • com.ckant.joplin-plugin-better-code-blocks
  • plugin.calebjohn.MathMode

Screenshots

A notification, "The following plugins may not support the current markdown editor: list item Math Mode", offers a choice to "Switch to the legacy editor" or "Dismiss"
The "Enable spellcheck in the Markdown editor" setting is no longer in beta, "use the legacy Markdown editor" is included in the "general" tab.

Manual testing

  1. Install the "math mode" plugin.
  2. Install another plugin, if only one plugin is installed.
  3. Open the editor.
  4. Verify that the compatibility warning is shown.
  5. Click "dismiss".
  6. Verify that the compatibility warning is hidden.
  7. Disable the plugin that is not "math mode" and restart Joplin.
  8. Verify that the compatibility warning is still hidden.
  9. Re-enable the plugin disabled in step 7 and restart Joplin.
  10. Verify that the compatibility warning is still hidden.
  11. Show the compatibility warning.
    • I did this from the development tools using Setting.setValue('editor.pluginCompatibilityBannerDismissedFor', [])
  12. Click "Switch to the legacy editor".
  13. Verify that the compatibility warning is no longer visible.
  14. Verify that the legacy editor is enabled.
  15. Disable the legacy editor in settings.
  16. Verify that the compatibility warning is visible.

This has been tested successfully on Ubuntu 24.04.

@laurent22
Copy link
Owner

A notification, "One or more installed plugins does not support the current markdown editor", offers a choice to "Switch to the legacy editor" or "Dismiss"

Would it be possible to display the list of plugins that are not compatible? I could imagine some users will choose to stay on the new editor if the incompatible plugin is something they rarely use, or even never use.

@laurent22 laurent22 merged commit e5c8b4b into laurent22:dev Aug 2, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants