Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[Feature]: 内置 Markdown 查看器/编辑器支持数学公式(KaTeX)渲染

未关闭
#1,952 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

  • #2042 来自 @xielixing —— 已关闭,未合并

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
react, typescript
领域
desktop, frontend

调研方向

从 src/web-ui/src/component-library/components/Markdown/Markdown.tsx 和 MarkdownMathRenderer.tsx 开始,以了解现有的聊天数学处理路径,然后检查 MarkdownEditor.tsx 和 src/web-ui/src/tools/editor/meditor/extensions/。比较两个入口点,并使用提供的公式运行 Markdown 查看器。完成的标准是:打开的 .md 文件中的行内数学和块级数学能够渲染,而代码块中的美元符号保持不变。

由索引模型根据 Issue 内容生成。

描述

feature good first issue
Problem / opportunity

BitFun 内置的 Markdown 查看器/编辑器(打开 .md 文件时使用)不渲染数学公式,$...$ 与 $$...$$ 只显示为原始文本;而对话(chat)中的 Markdown 已经支持 KaTeX 公式渲染。两者渲染能力不一致。

对以 Markdown + LaTeX 记笔记的用户(如数学/理科笔记)影响较大:在 BitFun 内打开自己的笔记看不到公式渲染,只能借助外部编辑器,或自行编写 MiniApp 阅读器绕过。

根因(源码层面):BitFun 内部有两套独立的 Markdown 渲染路径——

  1. 对话渲染(已支持公式):src/web-ui/src/component-library/components/Markdown/Markdown.tsx 通过 mayContainMarkdownMath() 检测 $$ / \( / \[ / 行内 $...$,命中后懒加载 MarkdownMathRenderer.tsx(react-markdown + remark-gfm + remark-math + rehype-katex)。
  2. 文件查看器/编辑器(不支持):打开 .md 走 FileViewerScene → ContentCanvas → MarkdownEditor(src/web-ui/src/tools/editor/components/MarkdownEditor.tsx),底层是 tiptap 编辑器(src/web-ui/src/tools/editor/meditor/),其 extensions/ 只有 Alignment / Image / Table 扩展,没有任何数学公式扩展。
Proposed behavior

文件查看器/编辑器的预览能像对话一样渲染行内($...$、\(...\))与块级($$...$$、\[...\])数学公式。

建议方案(任选其一或结合):

  • 为 tiptap 编辑器(meditor)增加数学节点扩展(社区已有成熟的 tiptap + KaTeX 扩展可参考),复用现有 KaTeX 依赖;
  • 或让文件预览复用 component-library 的 Markdown + MarkdownMathRenderer 渲染路径,统一两套渲染的公式能力。
Product surface

Desktop app

Details, examples, or constraints

复现步骤:

  1. 工作区放一个含公式的 .md 文件,例如:质能方程 $E=mc^2$,以及 $$\int_0^1 x^2 dx = \frac13$$
  2. 在 BitFun 内打开该文件(文件查看器)→ 公式原样显示,未渲染
  3. 对比:把同样内容让 AI 在对话中输出 → 公式正常渲染

验收标准:

  • 打开含 $...$ / $$...$$ 的 .md 文件,公式以排版形式渲染
  • 代码块内的 $ 不被误判为公式

环境:Windows 11,BitFun 桌面版。

主要语言
Rust
星标
2.3k
派生
236
平均合并
3 小时 38 分钟
30 天内合并 PR
329

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

GCWing/OpenBitFun 的其他 Issue

查看 GCWing/OpenBitFun 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。