Skip to content

Conversation

@KKKZOZ
Copy link

@KKKZOZ KKKZOZ commented Oct 21, 2025

This PR introduces a new Python script, [format_markdown.py], to automatically check and format all Markdown files in the repository.

The script enforces the following formatting rules to improve readability, especially for mixed Chinese and English content:

  1. Spacing: Adds a single space between English words/formulas and Chinese characters.
  2. Punctuation: Ensures Chinese text uses full-width punctuation (e.g., ,。?) and that sentences end with a full-width period (。).
  3. Punctuation Spacing: Removes any space between an English word/formula and an adjacent full-width punctuation mark.

In this commit, the script has been run across the entire repository, and all existing Markdown files have been updated to conform to these new standards.

@jjyaoao
Copy link
Collaborator

jjyaoao commented Oct 21, 2025

Hi,感谢贡献,不过这里有一些改动其实是会影响排版美观的,而且因为涉及的文件量太大,所以不推荐一次性运行到所有的markitdown文件,最好的方案是,你可以对具体的文档或者本身排版混乱的地方(比如在中文逗号中混杂了一个英文逗号)进行检查。

@KKKZOZ
Copy link
Author

KKKZOZ commented Oct 21, 2025

Hi,感谢贡献,不过这里有一些改动其实是会影响排版美观的,而且因为涉及的文件量太大,所以不推荐一次性运行到所有的markitdown文件,最好的方案是,你可以对具体的文档或者本身排版混乱的地方(比如在中文逗号中混杂了一个英文逗号)进行检查。

其实我更关心的是中英文之间没空格的情况,这部分在目前的文档中相当混乱,有些地方没加,有些地方又加了,可能需要统一一下

@jjyaoao
Copy link
Collaborator

jjyaoao commented Oct 21, 2025

Hi,感谢贡献,不过这里有一些改动其实是会影响排版美观的,而且因为涉及的文件量太大,所以不推荐一次性运行到所有的markitdown文件,最好的方案是,你可以对具体的文档或者本身排版混乱的地方(比如在中文逗号中混杂了一个英文逗号)进行检查。

其实我更关心的是中英文之间没空格的情况,这部分在目前的文档中相当混乱,有些地方没加,有些地方又加了,可能需要统一一下

我感觉有的地方的空格不是必要的,有的地方的确会变得美观。我觉得没有空格也不会影响什么,但你说的“混乱”的确存在,不过建议不要用脚本来改,我建议是你在脚本改的基础上一行一行看看对应的文案。文案的正确性应该摆在第一位。
image-20251021215901259

image-20251021215938478 image-20251021220148971

@jjyaoao
Copy link
Collaborator

jjyaoao commented Oct 21, 2025

另外现在教程还没有到宣发阶段,并且正文内容还差一些没完整,所以现在合入有可能会导致接下来更新的内容风格不统一,建议全文写好定稿后统一修改

@KKKZOZ
Copy link
Author

KKKZOZ commented Oct 21, 2025

另外现在教程还没有到宣发阶段,并且正文内容还差一些没完整,所以现在合入有可能会导致接下来更新的内容风格不统一,建议全文写好定稿后统一修改

OK, 标点符号这部分用脚本考虑的细节比较多,确实有很多会出错的地方,我先把脚本修改一下,只考虑正文中英文之间空格的部分

@KKKZOZ KKKZOZ marked this pull request as draft October 21, 2025 11:11
@jjyaoao
Copy link
Collaborator

jjyaoao commented Oct 21, 2025

另外现在教程还没有到宣发阶段,并且正文内容还差一些没完整,所以现在合入有可能会导致接下来更新的内容风格不统一,建议全文写好定稿后统一修改

OK, 标点符号这部分用脚本考虑的细节比较多,确实有很多会出错的地方,我先把脚本修改一下,只考虑正文中英文之间空格的部分

可以的,然后记得自己挨着review一下。因为改动的数量是相当大的,可能会有奇怪的问题

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants