kafka-learn / kafka-doc

kafka文档翻译,问题整理等
https://doctording.gitbooks.io/kafka-doc/
8 stars 5 forks source link

gitbook translation 插件使用问题 #6

Open doctording opened 6 years ago

doctording commented 6 years ago

markdown 中,对列表的支持可能有问题,因为gitbook版本问题,参见

https://www.npmjs.com/package/gitbook-plugin-translated

https://www.npmjs.com/package/gitbook-cli/v/2.3.1

查看自己的gitbook version 是否是 <= 3.1.1

gitbook -V 

如果版本太高,可以运行如下的命令,进行发布

gitbook fetch 3.1.1
gitbook build --gitbook=3.1.1
gitbook serve --gitbook=3.1.1

需要写成如下, 注意 eg3与中文1,在md文档中空了两行,不是一行

* eg1

* eg 2

* eg3

* 中文1

* 中文2

* 中文3
doctording commented 6 years ago

或者使用如下, 英文正常的编写, 中文在英文后,中文行首敲个Tab键

* Publish and subscribe to streams of records, similar to a message queue or enterprise messaging system.

    发布和订阅记录流,类似于消息队列或企业消息系统

* Store streams of records in a fault-tolerant durable way.

    存储记录流并能容错

* Process streams of records as they occur.

    即时处理记录流
doctording commented 6 years ago

对于列表,如果开头有特殊符号,显示上可能会有问题,如下,开头有 **** 加粗,就会有问题

* **test** for bold 

    **测试**字体加粗

* **test** for bold 2

     **测试**字体加粗2

对于这个错误可以改成如下,列表写完后,在写中文翻译,并且英,中文中间用两行空行

* **test** for bold 

* **test** for bold 2

* **测试**字体加粗

* **测试**字体加粗2

同理

* ```test``` for bold 

* ```test``` for bold 2

* ```test```字体加粗

* ```test```字体加粗2
doctording commented 6 years ago

对于行首有特殊符号,如``````的情况,注意保持中英文的一致性,否则显示也会有问题

test 字体加粗

* 错误做法,中文中没有``````

test for bold

test字体加粗