orchitech/redmine-gfm repository overview

⁠Supported tags

• latest, 4, 4.2, 4.2.1, 4.2.0
• alpine, 4-alpine, 4.2-alpine, 4.2.1-alpine, 4.2.0-alpine
• passenger, 4-passenger, 4.2-passenger, 4.2.1-passenger, 4.2.0-passenger

⁠Redmine image with CommonMark formating

This project provides dockerized Redmine with the new CommonMark Markdown formatting variant, as thouroughly discusessed at the corresponding patch⁠.

The current Redmine Markdown formatter is based on a poorly maintained Markdown implementation with several functional and security issues. While the new implementation is ready, the merge & release process apparently takes a couple of years. That's why we offer this as an alternative until the new formatting is officialy implemented.

The provided Docker images build on the official Redmine image⁠ and provide:

• the CommonMark formatting patch
  • uses CommonMarker⁠
  • introduces HTML::Pipeline⁠, which should be later used for other formatters too (#35035⁠)
• a few fixes and improvements in the text formatting area:
  • #35104⁠ - consistent rendering of code blocks
  • #32766⁠ - remove unnecessary link target limitation

⁠How to use this image

Exactly the same way as the official Redmine image⁠.

⁠How to use the new formatter

Redmine installed from this image adds the CommonMark Markdown (GitHub Flavored) formatter, identified as common_mark. You can switch to it in Administration - Settings.

⁠Other addressed issues

Last but not least, this formatter solves a number of currently open issues regarding the RedCarpet based Markdown Formatter:

• #19880⁠ (Incorrect syntax for links in Markdown)
• #20497⁠ (Markdown formatting supporting HTML)
• #20841⁠ (Bare URLs in Markdown don't have "external" class)
• #29172⁠ (Markdown: External links broken)

⁠Related tools

The redmine_reformat⁠ plugin can help you with migrating your data both from Textile and the old Redmine/Redcarpet Markdown format.