Back

使用gitbook 来写作 - gitbook.com网站用法相关

发布时间: 2015-06-21 01:49:00

refer to:   gitbook.com ,  英文文档不太好找,在: https://help.gitbook.com

之前写过一些东西,比如:  velocity的文档, checkstyle的文档等等。用的是docbook  , 一种使用XML语言来写代码,然后生成多种 格式的技术(html, single html, pdf )

为什么不用word写呢?  因为无法做diff.   纯文本的力量比word大很多。(不过也看编辑的要求了)

14年接触到了 swift的翻译, 使用了gitbook, (梁杰选择了 它,很有灵气)  

markdown化果然是大势所趋。  只需要很短的时间,记住几个常用的markdown, 就可以写书了。

放到了github上,可以把它从private 做成了 public repo, 希望大家都可以参与。

希望在我们写作这本书的过程中,大家能多提意见,毕竟好书是改出来的。

步骤:

1. 注册gitbook. 

2. 新建个  organization

3. 新建 book, 可以直接选择 import , 

4. 新建完book之后,也可以在设置中, 设置某本书与git repo中的关联,然后直接在gitbook.com中修改git repo中的内容。

Gitbook Settings

5. 写好的东西,还可以直接发布。给人看。 

6. 提供了非常友好的操作界面。如下图。

Gitbook Editor

7. 新建SUMMARY.md 文件:

# Summary

* [序言](chapter1.md)
* [概述](chapter2.md)
* [入门](chapter3.md)

注意:

关联到帐号的时候,要使用https://github.com...   而不是git://的形式。

8. 记得: 对于 {{ }}, 这样的符号,是被gitbook 占用了。  

{{ hi }}  正常

{{ hi('lala') }} 报错。

解决办法: 把会报错的 {{ 都改成:  {% raw %}{{{% endraw %}   , 也就是说, 前面被 {% raw%} 包围, 后面被 {% endraw %} 包围。 

Back