bpf-developer-tutorial icon indicating copy to clipboard operation
bpf-developer-tutorial copied to clipboard

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

Open Milkve opened this issue 1 year ago • 4 comments

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 avatar Feb 27 '24 11:02 Milkve

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 avatar Feb 27 '24 11:02 Milkve

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

Officeyutong avatar Feb 28 '24 08:02 Officeyutong

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

yunwei37 avatar Feb 28 '24 08:02 yunwei37

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: https://github.com/Tencent/tdesign/issues/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!

Milkve avatar Feb 28 '24 12:02 Milkve