feat: support tex math dollar syntax in project documentation #163
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
This is a best-guess limit, since the default for `katex`is `Infinity`, meaning the user could make arbitrarily large elements and spaces. This hopefully will strike a good balance between what the user can do and what's appropriate for the website.
krisjdev
commented
Dec 16, 2025
| shuttleMapSvg, | ||
| }: IProjectPropProps) { | ||
| const md = MarkdownIt(); | ||
| const md = MarkdownIt().use(require('markdown-it-texmath'), { |
Contributor
Author
There was a problem hiding this comment.
Is using require('markdown-it-texmath') correct here? I tried using import but it wasn't auto-completing - I'm assuming I'm missing some type files for it?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Ref TinyTapeout/tinytapeout-gf-0p2#90
This PR adds support for rendering math using the tex dollar syntax (
$$..$$and$..$) in the project documentation on the website. This brings it more in-line with the shuttle datasheet, as it uses the tex dollar syntax too.Using the project above as an example with the new changes:
I had originally mentioned markdown-it-dollarmath, but that package hasn't been updated for the node version being used, so I had to switch to
markdown-it-texmath.I've marked this as a draft PR for now since there's some points I want to address:
throwOnError,strictandtrustoptions forkatex(docs), but I feel like that isn't sufficient - do you know of any resources for better testing?