feature: Omit/obey escape character rules (backslash) when rendering markdown

[JakePi3]

Is your feature request related to a problem? Please describe.

I had a markdown file where I was documenting some neovim keybinds. When I use text like "<leader>ab", without the embedded backslashes, the leader is interpreted as an HTML tag. According to markdown syntax, angle brackets can be escaped with backslash.

Instead, the backslashes are visible in the markdown render even when the cursor is not at the given line.

Describe the solution you'd like

Omit (but respect) the backslash character from the render. Basically see how github renders the Preview of my problem description and replicate.

Source: https://www.markdownguide.org/basic-syntax/#escaping-characters

TLDR: Obey escaping rules. Render \< as <

Describe alternatives you've considered

This is not a big deal, doesn't impact functionality. I did search through existing issues but didn't find anything related to escape character.

Additional information

No response

[MeanderingProgrammer]

I think for this feature enabling it through treesitter highlights is the way to go, rather than requiring some new behavior from this plugin: https://github.com/nvim-treesitter/nvim-treesitter?tab=readme-ov-file#adding-queries

To do this create a file in your neovim configuration root: queries/markdown_inline/highlights.scm.

Then set this as the contents of that file:

;; extends

((backslash_escape)
  @backslash
  (#offset! @backslash 0 0 0 -1)
  (#set! conceal ""))

[quadruple-output]

Thanks, @MeanderingProgrammer, I had the same issue, and your proposal works perfectly. Would you consider documenting this, perhaps in the wiki? Or is there a way to have this query installed as part of your plugin?

[MeanderingProgrammer]

Sure, have created a discussion to track useful highlights: #335

[JakePi3]

Fantastic, worked for me as well as described.

[mostafatouny]

It worked perfectly with me also. Thank you.