Skip to content

Update README.md #36

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.

Sign up for GitHub

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

Merged
wendyyuchensun merged 2 commits into from
May 5, 2026
Merged

Update README.md #36

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c3183d
Update README.md
wendyyuchensun May 3, 2026
cc8f8b4
chore: update README
wendyyuchensun May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ const content = seeMarkReactParse(markdown);
| enableLatex | boolean | true | When false, LaTeX expressions are not parsed as math. |
| enableAsciimath | boolean | true | When false, AsciiMath expressions are not parsed as math. |
| enableNemeth | boolean | true | When false, the Nemeth braille math extension is disabled. |
| latexDelimiter | string | 'bracket' | The delimiter for LaTeX expressions. Options: 'bracket', 'dollar'. |
| asciimathDelimiter | string | 'graveaccent' | The delimiter for AsciiMath expressions. Options: 'graveaccent', 'asciimath'. |
| nemethDelimiter | string | 'at' | The delimiter for Nemeth braille expressions. Options: 'at' (`@…@`), 'nemeth' (`\n…\n`). |
| latexDelimiter | string | 'bracket' | The delimiter for LaTeX expressions. Options: 'bracket' (`\(...\)`), 'dollar' (`$...$`), 'latex' (`\l...\l`). |
| asciimathDelimiter | string | 'graveaccent' | The delimiter for AsciiMath expressions. Options: 'graveaccent' (`` `...` ``), 'asciimath' (`\a...\a`). |
| nemethDelimiter | string | 'at' | The delimiter for Nemeth braille expressions. Options: 'at' (`@...@`), 'nemeth' (`\n...\n`). |
| documentFormat | string | 'inline' | The format of the document. Options: 'inline', 'block'. |
| imageFiles | object | { [ID]: File } | A map of image IDs to File objects for image rendering. |
| shouldBuildImageObjectURL | boolean | false | should build image object URL. |
Expand Down Expand Up @@ -135,9 +135,9 @@ const toc = createTableOfContents(markdown);
| enableLatex | boolean | true | When false, LaTeX expressions are not parsed as math. |
| enableAsciimath | boolean | true | When false, AsciiMath expressions are not parsed as math. |
| enableNemeth | boolean | true | When false, the Nemeth braille math extension is disabled. |
| latexDelimiter | string | 'bracket' | The delimiter for LaTeX expressions. Options: 'bracket', 'dollar'. Must match the renderer. |
| asciimathDelimiter | string | 'graveaccent' | The delimiter for AsciiMath expressions. Options: 'graveaccent', 'asciimath'. Must match the renderer. |
| nemethDelimiter | string | 'at' | The delimiter for Nemeth braille expressions. Options: 'at' (`@…@`), 'nemeth' (`\n…\n`). Must match the renderer. |
| latexDelimiter | string | 'bracket' | The delimiter for LaTeX expressions. Options: 'bracket' (`\(...\)`), 'dollar' (`$...$`), 'latex' (`\l...\l`). Must match the renderer. |
| asciimathDelimiter | string | 'graveaccent' | The delimiter for AsciiMath expressions. Options: 'graveaccent' (`` `...` ``), 'asciimath' (`\a...\a`). Must match the renderer. |
| nemethDelimiter | string | 'at' | The delimiter for Nemeth braille expressions. Options: 'at' (`@...@`), 'nemeth' (`\n...\n`). Must match the renderer. |

### Return value

Expand Down