Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce rehype plugin support for Temml #107

Closed
4 tasks done
kurabirko opened this issue Jan 8, 2025 · 3 comments
Closed
4 tasks done

Introduce rehype plugin support for Temml #107

kurabirko opened this issue Jan 8, 2025 · 3 comments
Labels
💪 phase/solved Post is done

Comments

@kurabirko
Copy link

Initial checklist

Problem

Temml is a fork of KaTeX that renders equations into MathML Core. It is well maintained, well tested, provides better LaTeX coverage and with the adoption of MathML Core by Chromium it can be used with all major browsers. On top of this, Temml doesn't require additional CSS to render equations which is a major bonus. I think providing a rehype plugin for it provides real value without requiring too much maintenance effort as its API is very similar to KaTeX.

Current solutions

I have been rolling my own plugin module based off of rehpye-katex. However an official package would provide a much better developer experience.

Proposed solutions

I created a fork with an initial package implementation. If this proposal is accepted I would like to create a PR and merge the package into the upstream repository.

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Jan 8, 2025
@wooorm
Copy link
Member

wooorm commented Jan 9, 2025

Hi Utku!

I did see Temml before. It looks really really good. Someone made rehypejs/rehype#186. Why do you think an “official” package would provide a better developer experience? Are there other ways we can reach that better DX without making an “official” plugin?

@kurabirko
Copy link
Author

Hi again,

I was quite busy this week and I just had some time to check the pr you linked. It seems like the plugin is doing pretty much what I have been doing myself, so I have no complaints regarding the implementation. My only complaint might be that its naming makes the plugin a bit difficult to discover. I searched for a Temml Rehype plugin before opening this issue and nothing came up. As both KaTeX and MathJax can compile mathml to some extent (and as they are both located in this repository), it didn't occur to me to look for a plugin named rehype-mathml. Maybe mentioning it in this repository's readme file might be nice, I don't know?

Anyway, I think we can close this issue if you think that would be appropriate. I don't think there is all that much to gain from doing the same work twice.

@wooorm
Copy link
Member

wooorm commented Jan 20, 2025

👍

Finding good software is indeed sometimes difficult!
I am sure that project would be up for a PR to improve keywords, or other changes, to improve discoverability?
I am also open to adding it to the Related sections here, where useful, too!
Perhaps also Temml would like to link to projects?

@wooorm wooorm closed this as completed Jan 20, 2025
@wooorm wooorm added the 💪 phase/solved Post is done label Jan 20, 2025
@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💪 phase/solved Post is done
Development

No branches or pull requests

2 participants