markdownfmt icon indicating copy to clipboard operation
markdownfmt copied to clipboard

Disable formatting of code blocks by default

Open abhinav opened this issue 1 year ago • 0 comments

Creating this with regard to this comment originally posted by @karelbilek in https://github.com/Kunde21/markdownfmt/issues/38#issuecomment-1277758754:


To quickly explain - the original usage for this was mainly for go samples in code documentation.

I think the original behaviour doesn't need to be enabled by default... I think default behaviour should be to just not do any reformatting.

(I am surprised that Uber is using our stuff, but also happy! :D )

Btw maybe some added tests would be nice...


So this issue is to discuss/track whether the auto-formatting of code blocks should be disabled by default.

My opinion: I agree with @karelbilek. By default code blocks should be left alone, reproduced exactly as-is in the final output.

abhinav avatar Nov 16 '22 01:11 abhinav