Skip to content

Markdown formatter improvements

Enrique Alcántara requested to merge upgrade-markdown-formatter into master

What does this MR do?

A long-standing issue raised by users with editing Handbook pages in the Static Site Editor is that the editor introduces many formatting changes based on its predetermined preferences. These changes pollute the Merge Requests and makes code review more difficult. The fact that the Handbook’s Markdown pages don’t adhere to a consistent format worsen this situation.

A couple of months ago, we introduced a Markdown formatter based on the remark-stringify library to bring some stylistic consistency to the Handbook pages. This problem with this formatter is that it required a lot of manual work because it was breaking the content of the document, for example: Table of contents, bullet lists, and special characters.

This Merge Request improves remark-stringify to address to breaking changes. As a result, human intervention is not necessary to format a markdown document.

Related issues

#9964 (closed)

Edited by Enrique Alcántara

Merge request reports