Edit Subscript text in the Content Editor
Problem to solve
In order to support the full GitLab Flavored Markdown spec, the Content Editor must be support rendering and editing all the elements of the standard implementation .
Here, we are focused on editing Subscript text.
Intended users
- Parker (Product Manager)
- Presley (Product Designer)
- Sasha (Software Developer)
- Eddie (Content Editor)
User experience goal
The user should be able to create and edit Subscript text in the Content Editor.
Proposal
Create an extension for the Content Editor that supports editing Subscript text.
An icon should be displayed in the toolbar. The toolbar icon will apply or remove Subscript styling to any selected text and should reflect the state of the currently selected span of content. If the content is mixed (for example, the selected characters contain some bold and some regular text) then we should indicate the inactive state.
Note, per the GFM spec:
CommonMark and GitLab Flavored Markdown don’t support the Redcarpet superscript syntax ( x^2 ). Use the standard HTML syntax for superscripts and subscripts
Details
Extensions to the Content Editor require a few specific details:
Input Rule | N/A |
Paste Rule | [paste_rule] |
Toolbar Button | [icon] |
Keyboard Shortcut | [shortcut] |
Instrumentation | [event_name] |
Documentation
Availability & Testing
Available Tier
This feature, as with the content editor itself, is available on both SaaS and Self-managed Free tiers
What does success look like, and how can we measure that?
An event should be added to track creation of a new subscript text node through the UI. We aren't interested in tracking every instance of subscript text in existing content, but it would be great to know how often this extension is invoked through the editor, and whether it is done by using the toolbar, keyboard shortcut, or by typing directly into the editor.