Indented Markdown diff does not handle empty newlines about just-the-docs HOT 2 CLOSED

Hi @samchungy, thanks for the detailed bug report! Taking a quick look: this is more of a limitation of the syntax highlighter that Jekyll uses (which, among other things, decides what should be highlighted when using the diff "language" for syntax highlighting) rather than Just the Docs itself. You might get some mileage out of reconfiguring the syntax highlighter (or picking a different one). I'd be happy to help here, but am admittedly quite backlogged with work.

In the interest of unblocking you, you mentioned:

Unfortunately Prettier removes these by default.

Could a stopgap solution be to wrap your code blocks with <!-- prettier-ignore -->? If you're not familiar, this will tell prettier to skip formatting specific blocks of text. We frequently use this at Stylelint where we also run prettier across docs pages with very intentional whitespace choices. More on that in the Prettier docs on ignoring code.

Regardless, happy to dig into this more if there isn't a workable solution, but wanted to throw that ASAP!

from just-the-docs.

Interesting, I wasn't aware of that syntax! Thanks for the prompt reply 🙏I'll mark it as closed since it isn't an issue on your end 🙂

from just-the-docs.