Rendering equations in Redocly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
I want to render LaTeX equations in my documentation.
Describe the solution you'd like
Use KaTeX to automatically render equations like $$x^2$$.
Describe alternatives you've considered
I tried including KaTeX or MathJax as extra scripts, but since Redocly uses React, modifying the DOM doesn't seem to work. Manually converting LaTeX to MathML works but is cumbersome and leads to cluttered Markdown files.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing Redocly's React documentation-rendering path and how Markdown content is processed. Review the KaTeX API and determine where equations such as $$x^2$$ should be recognized and rendered without requiring extra scripts or manual MathML. Done means LaTeX equations render correctly in generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- latex, react, typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100