Gitbook 写文章的注意事项

2016 年 10 月 19 日

最近用gitbook在翻译某技术文档,记录一点注意事项。

  1. 如果用github账户登录,则无法用git从gitbook直接下载书籍源码,原因不明,但似乎是因为git命令行无法做oauth认证(怀疑可以用github的token来处理,未尝试)。同样,无法git push。但可以用本地编辑器的sync来push。

  2. 关于本地编辑器

  • 可以实时预览,但是经常会改变文本格式,而且copy/paste非常慢(估计是做文本检查的缘故),所以可以考虑用喜欢的编辑器直接修改本地文件。
  • 本地编辑器下载的git工程在windows下位于users/username/gitbook/library
  • 如果通过其他编辑器直接修改本地文件,在本地编辑器里面是看不到的,必须用git add/commit之后才能看到。如果直接打开本地编辑器,会导致修改丢失。
  1. 关于格式
  • br标签换行通常是在换行不需要空行的时候用。普通的换行,也就是连续的两行中间没有空行,如果下面的一行不是列表之类,是不认的。但如果两行之间留一行空行。则会被加上p标签,也就是分段了。
  • table用html格式也可以,用原始的格式再加br标签来控制换行也可以,不要怕一行太长。
  • 缩进很重要
Top