Skip to content

feat: support Math in Markdown #299

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

Draft
lumirlumir wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

feat: support Math in Markdown #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1129c0a
feat: support Math in Markdown
lumirlumir Jan 27, 2026
33389e3
Merge branch 'main' into lumirlumir-patch-1
lumirlumir Mar 31, 2026
2738318
wip
lumirlumir Mar 31, 2026
d4d1a09
wip
lumirlumir Mar 31, 2026
8881315
wip
lumirlumir Mar 31, 2026
69d750c
Merge branch 'main' into lumirlumir-patch-1
lumirlumir Apr 13, 2026
fca5c21
wip
lumirlumir Apr 13, 2026
9e95964
wip
lumirlumir Apr 13, 2026
b323f1e
wip
lumirlumir Apr 13, 2026
052bf88
wip
lumirlumir Apr 20, 2026
1c9d590
Merge branch 'main' into lumirlumir-patch-1
lumirlumir Apr 20, 2026
7a2e0c8
Merge branch 'main' into lumirlumir-patch-1
lumirlumir Apr 28, 2026
814104e
wip
lumirlumir Apr 28, 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
8 changes: 8 additions & 0 deletions e2e-tests/options.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,14 @@ test("should switch language and show options for each", async ({ page }) => {
await expect(
page.getByRole("combobox", { exact: true, name: "Front Matter" }),
).toBeVisible();

// `Math` Switch
await expect(
page.getByRole("switch", {
exact: true,
name: "Math",
}),
).toBeVisible();
});

// CSS
Expand Down
14 changes: 13 additions & 1 deletion src/components/options.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ const JSONPanel: FC = () => {
const MarkdownPanel: FC = () => {
const explorer = useExplorer();
const { markdownOptions, setMarkdownOptions } = explorer;
const { markdownMode, markdownFrontmatter } = markdownOptions;
const { markdownMode, markdownFrontmatter, markdownMath } = markdownOptions;
return (
<>
<LabeledSelect
Expand Down Expand Up @@ -96,6 +96,18 @@ const MarkdownPanel: FC = () => {
items={markdownFrontmatters}
placeholder="Front Matter"
/>

<LabeledSwitch
id="markdownMath"
label="Math"
checked={markdownMath}
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checked={markdownMath} assumes the value is always a boolean, but if a user has older persisted state (before markdownMath existed) it can be undefined and cause controlled/uncontrolled issues. Either ensure rehydration/migration fills markdownMath, or defensively coalesce here (e.g. default to false).

Suggested change
checked={markdownMath}
checked={markdownMath ?? false}

Copilot uses AI. Check for mistakes.
onCheckedChange={(value: boolean) => {
setMarkdownOptions({
...markdownOptions,
markdownMath: value,
});
}}
/>
</>
);
};
Expand Down
4 changes: 3 additions & 1 deletion src/hooks/use-ast.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ export function useAST() {
}

case "markdown": {
const { markdownMode, markdownFrontmatter } = markdownOptions;
const { markdownMode, markdownFrontmatter, markdownMath } =
markdownOptions;
const language = markdown.languages[markdownMode];
astParseResult = language.parse(
{ body: code.markdown, path: "", physicalPath: "", bom: false },
Expand All @@ -76,6 +77,7 @@ export function useAST() {
markdownFrontmatter === "off"
? false
: markdownFrontmatter,
math: markdownMath,
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If markdownMath is missing from rehydrated persisted state, math: markdownMath can be undefined. Consider defaulting this to false here (and/or adding a persist migration) so the parser option is always a boolean.

Suggested change
math: markdownMath,
math: markdownMath ?? false,

Copilot uses AI. Check for mistakes.
},
},
);
Expand Down
1 change: 1 addition & 0 deletions src/hooks/use-explorer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export type JsonOptions = {
export type MarkdownOptions = {
markdownMode: MarkdownMode;
markdownFrontmatter: MarkdownFrontmatter;
markdownMath: boolean;
};

Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a new field to MarkdownOptions can break existing persisted state: zustand persist merges state shallowly, so older markdownOptions objects will overwrite defaultMarkdownOptions and may omit markdownMath, yielding undefined at runtime. Consider adding a persist version + migrate/custom merge, or patching rehydrated markdownOptions to include markdownMath: false when missing.

Suggested change
type PersistedMarkdownOptions = Omit<MarkdownOptions, "markdownMath"> & {
markdownMath?: boolean;
};
export const normalizeMarkdownOptions = (
markdownOptions?: PersistedMarkdownOptions,
): MarkdownOptions => ({
...defaultMarkdownOptions,
...markdownOptions,
markdownMath: markdownOptions?.markdownMath ?? false,
});

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member Author

@lumirlumir lumirlumir Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll dig into this problem a bit more in the near future.

export type CssOptions = {
Expand Down
1 change: 1 addition & 0 deletions src/lib/const.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,7 @@ export const defaultJsonOptions: JsonOptions = {
export const defaultMarkdownOptions: MarkdownOptions = {
markdownMode: "commonmark",
markdownFrontmatter: "off",
markdownMath: false,
};

export const defaultCssOptions: CssOptions = {
Expand Down