personal-site
markdown-it-texmath
Our great sponsors
personal-site | markdown-it-texmath | |
---|---|---|
1 | 2 | |
0 | 146 | |
- | - | |
4.4 | 1.9 | |
about 1 month ago | about 1 month ago | |
CSS | HTML | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
personal-site
-
Math on GitHub: Following Up
A GitHub bug I recently noticed that seems related:
Expected: When a repo's readme is named `README` (without the `.md` suffix), it is rendered as plain text. When a repo's readme is named `README.md`, it is rendered as Markdown.
Actual: When a repo's readme is named `README` (without the `.md` suffix), the presence of `$` causes parts of the file to be rendered as math. For a real-life example, see the readme in https://github.com/idianal/personal-site.
Can someone please point me where I can submit a bug report/issue for this?
markdown-it-texmath
-
Math on GitHub: Following Up
Github's implementation is really lazy. There are many much better approaches to precisely this problem. E.g., Jupyter notebooks implement one that has matured in the wild over a decade. There's this very flexible markdown-it plugin that implements anther https://github.com/goessner/markdown-it-texmath, and my version of it here https://github.com/sagemathinc/cocalc/blob/master/src/packag... which I rewrote in typescript with a focus on the same semantics as Jupyter has, but for CoCalc, and I've been working on using unifiedjs to provide more general latex for Markdown (not just formulas) here https://github.com/sagemathinc/cocalc/pull/5982 Parsing math is much easier if you use a plugin to an existing markdown parser, rather than trying to do some hack outside of that (which is what Github probably does, and also what Jupyter does).
-
Math on GitHub: The Good, the Bad and the Ugly
If you use a proper markdown plugin to parse math instead (such as https://github.com/goessner/markdown-it-texmath), then the problems pointed out in this blog post go away.
What are some alternatives?
Franklin.jl - (yet another) static site generator. Simple, customisable, fast, maths with KaTeX, code evaluation, optional pre-rendering, in Julia.
MathJax-src - MathJax source code for version 3 and beyond
pandoc - Universal markup converter
KeenWrite - Free, open-source, cross-platform desktop Markdown text editor with live preview, string interpolation, and math.
kroki - Creates diagrams from textual descriptions!
cocalc - CoCalc: Collaborative Calculation in the Cloud