yangby-cryptape
commented
1 year ago I think this suggestion is good, but a bit early for now, since the inline LaTeX had so many bugs and unstable.
-
Bugs: I had opened tickets for those bugs SEVERAL WEEKS AGO, but GitHub hasn't fixed them.
The last time (more than a month ago), they replied to me:
There isn't an ETA we can share for the moment, but we'll keep you informed of our progress.
Thank you for your patience and sorry for the inconvenience!
Since then, I got no feedback.
Here is one example:
-
A formula in RFC-0020:
-
Rendered by GitHub (If you see the correct rendering, that means at least they fixed one bug I met):
$$ HPS{i} = \left{ \begin{aligned} & HPS{i-1} \times \frac{1}{\tau} \;, & \overline{HPS{i}} \lt \frac{1}{\tau} HPS{i-1} \ & HPS{i-1} \times \frac{1}{\tau} \;, & \overline{HPS{i}} \gt \tau HPS{i-1} \ & \overline{HPS{i}} & \text{otherwise} \ \end{aligned} \right. $$
p.s. This LaTeX code has been tested with both MathJax Demo and StackEdit (KaTeX backend).
Click HERE to see the LaTeX Code.
``` $$ HPS_{i} = \left\{ \begin{aligned} & HPS_{i-1} \times \frac{1}{\tau} \;, & \overline{HPS_{i}} \lt \frac{1}{\tau} HPS_{i-1} \\ & HPS_{i-1} \times \frac{1}{\tau} \;, & \overline{HPS_{i}} \gt \tau HPS_{i-1} \\ & \overline{HPS_{i}} & \text{otherwise} \\ \end{aligned} \right. $$ ``` -
-
Unstable: some days the rendering are correct, but some days are incorrect.
I had to tolerate that when I wrote RFC-0044.
RFCs like https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0020-ckb-consensus-protocol/0020-ckb-consensus-protocol.md uses a lot of formulas. Since GitHub has shipped the feature to render inline LaTeX, it's time to replace the images for better reading experience.
RFC like https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md can replace code tags with LaTex as well.