docs: introduce KaTeX local copy plugin & Temml for math #11115
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
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Sign up for free
to 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.
Pre-flight checklist
If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.N/AIf this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.N/AMotivation
It is a pain in the neck to manage and copy all .woff2 files of KaTeX in your repository to host them in your server.
My plugin https://npmjs.com/package/@tats-u/docusaurus-plugin-copy-katex-assets will be helpful and worth introduced.
Ideally, this kind of plugin should be managed by Docusaurus itself, not an outsider like me.
Also, Temml is better than KaTeX if you prefer extremely small download size or non Latin Modern Math fonts and also worth introduced.
https://www.npmjs.com/package/@daiji256/rehype-mathml can be used instead of rehype-katex to use Temml.
Test Plan
Test links
Deploy preview: https://deploy-preview-11115--docusaurus-2.netlify.app/docs/markdown-features/math-equations/#mathml
Backports:
https://deploy-preview-11115--docusaurus-2.netlify.app/docs/3.7.0/markdown-features/math-equations/#mathml
https://deploy-preview-11115--docusaurus-2.netlify.app/docs/3.6.3/markdown-features/math-equations/#mathml
Related issues/PRs
#11100