servicemesher / istio-handbook

Istio服务网格进阶实战
Creative Commons Attribution 4.0 International
1.77k stars 327 forks source link

Markdown 格式及拼写检查 #18

Open rootsongjc opened 5 years ago

rootsongjc commented 5 years ago

添加一个 Markdown 格式检查器,防止文中的格式错乱 添加英文拼写检查,防止出现错字

DasyDong commented 4 years ago

关于英文的拼写检查

我了解的两个版本 go 和python 1 mispell是kubernetes社区在用的每次verify pr都会检查一次。功能很强,但有些拼写检查很弱, 有些真的拼写错误会漏掉

2 spell-check,我今天手写的, 基于pyenchant 这个检查Bug也很多, 会错误识别typo但不太会漏

总体上这两种下面这些都会识别出有问题, 譬如protocolbuffers, 但如果是protocolBuffers这种标准的就不会被标记成错误

zhongfox
istioctl
sinaimg
tKfTcgy
flw
dmj
wq
grn
referrerpolicy
oyaml
proxyv
productpage
cb
df
xlndw
gw
alipayobjects
mdn
rms
afts
GPdTIDlhD
AAAAAAAAAAABkARQnAQ
grafana
kiali
jaeger
xr
cfd
kjcsg
ingressgateway
cdd
zpv
dfdb
fd
xgt
qkk
msclx
fbc
fp
vzb
glt
cbxAQYM
DrgAAAAAAAAAAABkARQnAQ
mixs
mixc
bazel
protocolbuffers
MCP

我用spell-check检查了下istio-handbook,发现了一些typo, 我直接提pr了, 不知是否合适?