Skip to content

Edit horizontal rules (hr) in the Content Editor

Problem to solve

In order to support the full CommonMark spec, the Content Editor must be support rendering and editing all the elements of the standard implementation .

Here, we are focused on creating horizontal rules

Intended users

User experience goal

The user should be able to create and edit horizontal rules in the Content Editor.

Proposal

Create an extension for the Content Editor that supports editing horizontal rules.

An icon should be displayed in the toolbar. The toolbar icon will insert a new horizontal rule at the current cursor position.

Details

Extensions to the Content Editor require a few specific details:

Input Rule ---
Paste Rule [paste_rule]
Toolbar Button https://gitlab.com/gitlab-org/gitlab-svgs/blob/main/sprite_icons/dash.svg
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 horizontal through the UI. We aren't interested in tracking every instance of horizontal rules used 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.

What is the type of buyer?

Is this a cross-stage feature?

Links / references

Edited by Michael Le