Skip to content

Remove Markdown-it from Content Editor build

What does this MR do?

The Content Editor component uses the prosemirror-markdown library to serialize ProseMirror documents as Markdown strings. In turn, prosemirror-markdown uses markdown-it to deserialize a Markdown strings into ProseMirror documents. We don’t deserialize Markdown strings in the Content Editor so we don’t need markdown-it.

This MR removes markdown-it from the Content Editor bundle by changing the import statement of prosemirror-markdown to only target the to_markdown module. prosemirror-markdown does not support tree-shaking.

Screenshots (strongly suggested)

This MR does not introduce user-facing changes.

With markdown-it Without markdown-it Size Reduction
Screen_Shot_2021-04-21_at_9.30.06_AM Screen_Shot_2021-04-21_at_9.24.38_AM -33kb (from 45kb to 12kb)

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team

Merge request reports