Repository navigation
KaTeX and SsKaTeX: Usage notes and comparison - #493
Conversation
|
Thanks - I have merged your changes! |
| Requirements for running kramdown with math engine KaTeX: | ||
|
|
||
| - Ruby gem [`katex`][katex-gem], | ||
| - Ruby gem [`execjs`][ExecJS], |
There was a problem hiding this comment.
This is a runtime_dependency of the gem so there is no need to install it separately:
https://github.com/glebm/katex-ruby/blob/e432853a5ae1122e8dc8ce96147bded41494baef/katex.gemspec#L25
There was a problem hiding this comment.
That's just saying that the requirement usually gets fulfilled by dependency resolvers, but it's still a requirement. And it informs about what will (have to) be found in a functioning installation.
| - Ruby gem [`katex`][katex-gem], | ||
| - Ruby gem [`execjs`][ExecJS], | ||
| - A Javascript engine supported by ExecJS, e.g. via one of | ||
| - Ruby gem [`therubyracer`][therubyracer], |
There was a problem hiding this comment.
therubyracer is not a good choice for a runtime, mini_racer is better in every way.
There was a problem hiding this comment.
Those are just examples of what is supported by ExecJS. I have chosen therubyracer mostly because of the naming similarity to therubyrhino which is suitable for Jruby.
There was a problem hiding this comment.
Besides, ExecJS has a different view. Its autodetection prefers RubyRacer over MiniRacer, trying RubyRhino and Duktape in between. I do not suppose that that is an argument by itself; my actual point is that one should not interpret too much into that list of examples, because there is no way to satisfy all tastes anyway.
As promised, some usage notes and guidelines on where and whether to use KaTeX or SsKaTeX.