sysreptor icon indicating copy to clipboard operation
sysreptor copied to clipboard

[Feature Request] Provide markdown callouts

Open danymat opened this issue 2 months ago • 1 comments

Hello,

It would be great to provide a kind of markdown callout in Sysreptor, if feasible. They are called admonitions, or alerts (in github) Something like:

https://help.obsidian.md/callouts https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

What do you think ?

danymat avatar Oct 10 '25 08:10 danymat

Hi, thanks for the suggestion.

I'm not quite sure if we should introduce this markdown extension. There are some challenges:

  • It's a custom markdown extension not covered by the CommonMark spec. Each markdown parser has a slightly different implementation and syntax. The Obsidian an GitHub links you provided use different a syntax. This might result in incompatibilities with other markdown viewers.
  • Multi language support: GitHub syntax only supports English, Obsidian syntax can use other languages but requires supplying a title for every non-english callout.
  • Color schemes and customization: It should be possible to customize the colors of boxes. This can be achieved via CSS variables.

As a workaround you can use following CommonMark compliant markdown code to achieve a similar look (without colors, though).

> 🛈 **Note**
> 
> note text

MWedl avatar Oct 10 '25 10:10 MWedl