最近在用Gitbook整理工作中的FAQ。这两天遇到了一点Gitbook上的问题,纠结了很久,前后得有整整10个小时吧。Google并没有帮到我,而最后的结果,让我有了这篇文字标题的感受。

我都做了什么蠢事

  1. Gitbook的book.json配置,同级的不同的配置项之间要用逗号隔开。否则,你会遇到"unexpected string in json"这样的鬼话提示。天知道这是什么意思,而且google也不会告诉你,因为没有其他人会犯这么低级的错误。

    如果一个实务问题连谷歌都没有答案,那么一定是你犯了一个很愚蠢的错误,比如:错别字、缺乏基本常识。

    说到常识,不同领域间的常识对新手来说,真的非常不友好的。而网上的各种教程,也大多不是小白来写的,那些真小白会犯的错误,教程的作者恐怕想都想不到。

    所以,如果真的要接触一个新的领域,像素级的模仿是很好的办法。比如,创建一个Gitbook,可以直接去看别人Gitbook的book.json的配置。

  2. Gitbook生成时,一定要指定书籍文档所在的文件夹,否则就会出现类似找不到README.md这样的错误提示。

    正确的示范:

    // 直接在当前目录生成
    cd /Users/xiaobings/GitBook/Library/pkuflint/lecloud-faq
    gitbook build
    
    // 或者下面这种指定当前目录的子目录
    cd /Users/xiaobings/GitBook/Library/pkuflint
    gitbook build ./lecloud-faq
    

    错误的示范:

    // 当前目录中没有书籍时,不能使用build
    cd /Users/xiaobings/GitBook/Library/pkuflint
    gitbook build 
    
  3. Gitbook需要安装插件时,也一定要处在书籍文档所在的文件夹,否则会提示"nothing to install",与此同时,在你尝试build时,却提示你缺少插件,请运行gitbook install来安装插件。

    可参考上面的方式。

  4. Gitbook的插件如何配置,可以在Plugin Store中,找到该插件,然后点击插件名字右侧的图标链接来跳转到插件的说明页面,上面会显示该插件的配置项和实例代码。

  5. Gitbook生成的本地html页面,点击左侧章节是无法跳转的。新版Gitbook就是这样,据说用gitbook build --gitbook=2.6.7,实现用旧版Gitbook生成html,可以实现跳转。但旧版很多插件都不兼容,遂放弃。

  6. Gitbook Editor会自动同步_book目录,很烦人。前往gitbook.com在线去编辑.ignore文件,添加_book即可。一般这个是默认添加的,我应该是自己不小心改动了。

  7. 将website.css里的代码拷贝到pdf.css中,生成的pdf文档依然是没有那些样式。这个没有找到解决方案,放弃。

  8. gitbook.com在线编辑书籍,打开页面非常之慢,我在这个点耗尽了我所有的耐心。我的键盘如果被我砸坏了,这个锅要gitbook来背。

冷静一下

  • 对于不熟悉的领域,尤其是工具类,没事不要折腾。即使寂寞空虚,也还是有别的东西可以聊以排遣,别坑自己。
  • 事有轻重缓急,不要忘了这个最基本的工作方法论。被琐事绊住时,问下自己:这玩意有必要做么?有必要现在做么?如果答案是否,立即放弃,沉没成本也不要在意了。
  • I can do better.