Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.1k
feat(maths): add KaTeX support for server-side math rendering#2603
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
joshlk wants to merge2 commits intocotes2020:masterChoose a base branch fromjoshlk:katex_support
base:master
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+86 −13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 task
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type of change
Description
This PR adds support for KaTeX as an alternative math rendering engine to the existing MathJax implementation. Users can now choose between client-side rendering (MathJax) or server-side rendering (KaTeX) for mathematical expressions.
This can improve performance as KaTeX renders math expressions at build time, eliminating the need for client-side JavaScript processing and resulting in faster page loads. The changes maintain full backward compatibility, as it defaults back to MathJax if the user does no config changes.
KaTex does have some LaTeX missing features, such as
\labelis not supported.Changes
Configuration
math.enginesetting to _config.yml with options:mathjax(default) orkatexjektexconfiguration block for KaTeX rendering options (cache directory, ignore patterns, macros)jektex ~> 0.1.1gem dependency to jekyll-theme-chirpy.gemspecTemplate Logic
Styling
.katex-displayin _base.scss to prevent layout issues with wide equationsDocumentation
\labeland\eqref)Usage
Using MathJax (default, no changes required):
Using KaTeX:
Then add
jektexto your Gemfile and runbundle install.