Docstring-based rendering or math-block based rendering of Latex equations in documentation

[Fe-r-oz]

Hi, Stefan,

I recently came across the use of \ in Gabs.jl for rendering LaTeX-based equations, as highlighted in this PR: Gabs.jl PR #47. It’s a really neat feature as we don't need to escape the \ using \\!

However, I noticed that using \ throws a REPL error during compilation here, whereas \\ does not. I opened the discussion to highlight this nice feature of using \ to render equations in Gabs. I’ve been using \\ to escape certain LaTeX commands, which works without issues but it might not render properly 😅

I hope that we can also use \ instead of \\ but currently \ throws error on REPL. I hope you like this suggestion!

Thanks so much for your help!

Edit:

Please find the explicit example from PR #437 where I am using \\ to render the matrix in Latex and it renders on markdown. I think the following might not be the most ideal way of rendering (docstring-based rendering)

\$\$
\\begin{matrix}
1 & (\\alpha^1)^1 & (\\alpha^1)^2 & (\\alpha^1)^3 & \\dots & (\\alpha^1)^{n-1} \\\\
1 & (\\alpha^3)^1 & (\\alpha^3)^2 & (\\alpha^3)^3 & \\dots & (\\alpha^3)^{n-1} \\\\
1 & (\\alpha^5)^1 & (\\alpha^5)^2 & (\\alpha^5)^3 & \\dots & (\\alpha^5)^{n-1} \\\\
\\vdots & \\vdots & \\vdots & \\vdots & \\ddots & \\vdots \\\\
1 & (\\alpha^{2t-1})^1 & (\\alpha^{2t-1})^2 & (\\alpha^{2t-1})^3 & \\dots & (\\alpha^{2t-1})^{n-1}
\\end{matrix}
\$\$

Thank you so much to Tommy as well for providing clarification about doctsring rendering. 🙏🏼

[Fe-r-oz]

darn ... In most of my PRs, I am using \\, I realized I should just follow \ with math mode. My apologies if the question sounds stupid of me :|