Aiken Docs: Latex Support

[logicalmechanism]

What is your idea? Describe it in simple words. Provide a use case.

The aiken docs function uses the top level README file to generate the landing page to the documentation. If that file contains latex-style mathematics then it does not render it properly.

It would be nice to allow the syntax of LaTeX math mode to render properly in the documentation.

Why is it a good idea?

It makes the documentation looks prettier. 😸

So instead of documentation showing this:

g^{z} = g^{r +c \cdot x} = g^{r} g^{x \cdot c} = g^{r} (g^{x})^{c} = g^{r} u^{c}

\blacksquare

We get this:

$$g^{z} = g^{r +c \cdot x} = g^{r} g^{x \cdot c} = g^{r} (g^{x})^{c} = g^{r} u^{c}$$

$$\blacksquare$$

What is the current alternative and why is it not good enough?

There is not current alternative as latex math mode is not supported.

[adrian052]

Can I try this??

[logicalmechanism]

I think aiken docs just needs a way to parse it correctly. It just gets rendered as the text and not the math.

[adrian052]

I have created a new PR: #1070

[KtorZ]

As per latest release, this is now integrated 🫡