BlogsGitLabMarkdown Rendering Behavior

Markdown Rendering Behavior

Markdown Rendering Behavior

2
posts
2014–2021

GitLab's approach to rendering Markdown has evolved to align with established specifications, particularly concerning newline behavior. Initially, GitLab rendered all line breaks, but this was updated to conform to the Markdown specification, requiring two or more spaces at the end of a line for a newline. This change was applied consistently across various markdown-using areas like project files, issue descriptions, and comments to ensure a uniform user experience. The Web IDE and Web Editor now include a real-time, side-by-side preview panel for Markdown content, allowing users to see changes as they are made without context switching.

2021

GitLab's realtime Preview Markdown is an editor for everyone

9/21/2021

Introduced a real-time, side-by-side Markdown preview feature in the Web IDE and Web Editor. This feature allows users to toggle a split-screen live preview of their Markdown content, rendering changes as they are made. The functionality can be accessed by right-clicking the editor and selecting 'Preview Markdown' or by using the `Command/Control + Shift + P` shortcut.

2014

Markdown newline behaviour

2/21/2014

This post proposes and implements a change to GitLab's Markdown rendering to conform to the Markdown specification, specifically regarding newline behavior. Previously, GitLab rendered all line breaks. The change requires two or more spaces at the end of a line for a line break, while paragraphs remain separated by blank lines. This change is applied consistently across all GitLab Flavored Markdown usage, including markdown files, issue descriptions, and comments.