Skip to content
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.

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

[FEATURE] "Add space between English and Chinese" or "no space between English and Chinese" and keep one rule in one file #112

Open
Milkve opened this issue Feb 27, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@Milkve
Copy link
Contributor

Milkve commented Feb 27, 2024

Is your feature request related to a problem? Please describe.
It is typographical stuff like space between two languages and between word and digit. Indeed the tutorials are excellent, but the space style does not follow a consistent writing style, like https://github.com/eunomia-bpf/bpf-developer-tutorial/blob/main/src/0-introduce/README.md

image

Describe the solution you'd like
Either no space between English and Chinese and no space between word and digit, or one space between English and Chinese and one space between word and digit, in one tutorial docs. One file should has one style and keep it everywhere.

@Milkve Milkve added the enhancement New feature or request label Feb 27, 2024
@Milkve
Copy link
Contributor Author

Milkve commented Feb 27, 2024

I would like to help, and docs mending will start from https://github.com/eunomia-bpf/bpf-developer-tutorial/blob/main/src/0-introduce/README.md

Milkve added a commit to Milkve/bpf-developer-tutorial that referenced this issue Feb 27, 2024
Update tutorial-0 README.md with consistent whitespace style, and the related issue is: <eunomia-bpf#112 (comment)>
@Milkve Milkve mentioned this issue Feb 27, 2024
15 tasks
yunwei37 pushed a commit that referenced this issue Feb 27, 2024
Update tutorial-0 README.md with consistent whitespace style, and the related issue is: <#112 (comment)>
@Officeyutong
Copy link
Contributor

I think we should keep space between English and Chinese and stick to this rule, what do you think @yunwei37

@yunwei37
Copy link
Member

Yes, I think so. Is there any format tool for that?

@Milkve
Copy link
Contributor Author

Milkve commented Feb 28, 2024

My tool: 👓glasses, literally. Manually checking is my way, but it may sounds awkward to other people.

I know there are some extra tools for keeping space between English and Chinese:
https://www.lddgo.net/string/add-space-between-chinese-and-english
https://www.quanxiaoha.com/tools/wenzi-paiban/
https://www.wetools.com/type-setting
But those tools are more friendly to Chinese native speaker.

https://prettier.io/
image
This is a powerful tool supports many editors and not only works on markdown files, and I have never tried it before.

I also found other discussions about similar topic:
Tencent/tdesign#314
https://v2ex.com/t/654373
https://v2ex.com/t/827549
https://ifyour.github.io/2018/12/31/%E4%BB%A3%E7%A0%81%E6%B4%81%E7%99%96%E5%85%BB%E6%88%90%E6%8C%87%E5%8D%97/
https://icekylin.online/whitespace

Some people mentioned in discussions that tools may cause other issues. I am not sure and I have never tried before. If you have better suggestions don't hesitate to share with us!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants