Skip to content

[问题/Issue] 章节11.2.2/11.4.3:Github预览部分公式渲染报错 #531

@JPs-git

Description

@JPs-git

1. 遇到问题的章节 / Affected Chapter

Chapter11

2. 问题类型 / Issue Type

文档不清晰 / Unclear Documentation

3. 具体问题描述 / Problem Description

Github预览渲染一些公式时显示异常报错.

4. 问题重现材料 / Reproduction Materials

Chapter11.2.2 报错截图
Image

Image Image

Chapter 11.4.3 报错截图

Image

5. 补充信息 / Additional Information

推测的原因是Gihub预览中错误地把一些特殊字符如星号"*", "<"当作了markdown语法

建议使用命令 \ast, \lt等 显示特殊字符以同步Github Pages和Github Preview的渲染效果

下面是一种可能的修改方式, 经过测试在Github预览和Github Pages上都能够正常渲染

Image

目前受到影响的只有在同一个公式代码块中使用多个星号"*"的场景 以及在下标中使用尖括号"<"的场景, 需要评估是否需要修改以及修改的范围

确认事项 / Verification

  • 我已阅读过相关章节的文档 / I have read the relevant chapter documentation
  • 我已搜索过现有的Issues,确认此问题未被报告 / I have searched existing Issues and confirmed this hasn't been reported
  • 我已尝试过基本的故障排除(如重启、重新安装依赖等) / I have tried basic troubleshooting (restart, reinstall dependencies, etc.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions