GitBook使用入门


GitBook是什么?

Git

Git可能是目前全球最通用软件编程、软件开发项目的管理工具,帮助开发人员对项目文件和开发进度进行管理,支持版本历史管理和多人协作管理等必须功能。

GitHub

GitHub是Git在线化,就是有人把自家的git服务向所有人公开了,每个开发者都能使用它来在线管理自家的项目。目前它已经是全球最大的开源软件项目集散地地,很多知名的项目比如Nodejs,Tensorflow等等都是发布在GitHub上面的开源项目。

开源意味着你可以随时把整个项目的源代码拷贝到你的计算机上,和项目的开发人员同步看到项目的代码内容,看到项目的发展过程;也意味着你可以提出自己对项目代码的改进意见,并提及给项目管理人员,如果你的建议足够好或者你修改进的代码足够精彩,那么它会出现在项目的下一个版本中向全世界人发布。

GitBook

GitHub是基于Git技术的,是面向做软件开发的程序员的。GitBook同样是基于Git技术的,但它最初定位是面向软件说明文档的编写者的,但它同样适合任何类型的文字编辑工作者。

GitBook是使用软件项目的先进管理经验打造的在线文档书籍撰写工具

Git官网 / GitHub官网 / GitBook官网(新版,需要翻墙) / GitBook官网(旧版不需要翻墙)


GitBook工具链

GitBook在线网站旧版/新版
可以在线协作一起写书,并且直接发布到这个网站,方便分享和公众阅读。

GitBook开源项目
这是一个机遇Node.js的本机服务软件,他可以在断网状态下载浏览器内展示你的书籍。

GitBook Editor本机编辑器
离线的编辑器,支持Windows和MacOS、Linux,类似office word那种,但更简单写出书也更漂亮。


GitBook Editor编辑器

书籍管理

如果您没有梯子,可以在一开始选择Do that later暂不登录


延迟登录

从菜单GitbookEditor设置书籍存储目录Change Library Path,接下来书籍所有文件都会放到这里

设置目录

然后可以随便创建一个新书+new book,名称任意如MyFirstBook。

点左上角铅笔图标可以返回书籍列表。

文章管理

撰写界面

左侧列出了文章的内容列表TOC(Table of content),就是书的目录了。FILES文件模式是这个项目的实际使用的文件,先不用管。

已经有两篇文章introduction本书说明和First Chapter第一章。点击可以在右侧主区域打开并编辑。新建、重命名、删除、上下拖拽调整顺序,这些不再多说。

本地预览

请参照下一段GitBook本地服务

GitBook本地服务

安装

使用命令行安装GitBook本地服务。

npm install gitbook-cli -g

启动服务

然后cd进入你的书籍目录,比如xx/import/mybookname,然后执行命令启动服务

gitbook serve

如果你遇到问题,那么可能需要初始化一下。

初始化项目

gitbook init

更多使用参照这里

其实可以使用任意的编辑器来修改md文档,不仅仅限于Editor。


发布到legacy.gitbook.com

创建GitHub仓库

首先需要登录GitHub官网注册登录并创建一个项目start a project(仓库reposi'tory)。

创建项目

任意项目名称,其他默认,你将会得到一个GitHub仓库地址类似https://github.com/zhyuzh3d/mytestbook.git

上传到Github(自备梯子)

然后在编辑器book菜单sync,这会弹出提示需要输入上面的.git地址,然后要输入GitHub用户名和密码,稍后本地的书籍文件就上传到GitHub仓库了。

关联GitHub和GitBook(自备梯子)

回到legacy.gitbook.com,使用GitHub账号登录,然后从右上角头像Account Setting账号设置进入,左侧选GitHub,右侧Integration整合,install,这将让你选择把哪个repository仓库同步过来,可以选全部。

从GitHub仓库创建书籍

创建一本新书,然后从SETTINGS进入,再点左侧GitHub,然后输入你的GitHub仓库名,这样就把GitHub仓库变成GitBook书籍的形式展示了。
在GitBook里面点read阅读这个书籍,和本机serve的效果是一样的,而且当我们本机Editor修改之后,只要sync一下就能自动同步刷新了。

这个书籍的链接可分享或者发给朋友,当然确保你的朋友自备梯子...

其他同步到GitHub的方法

使用命令行或者界面化的Git工具,比如SourceTree,将import下的mytestbook文件夹推送到GitHub目录。
SourceTree教程看这里

在线编写(自备梯子)

也可以完全使用legacy的在线编写工具撰写书籍。


MardDown语法

GitBook都是基于markdown语法的,其实就是一些特殊的符号表示文字样式,比如一个#加空格代表这是一行大标题,两个##加空格代表这是二号标题,一个*加空格代表这是一个列表,>加空格代表后面的文字是注释,等等。

很多编辑器和网站都支持markdown语法,比如你现在看的这个简书文章就是markdown语法撰写的。

你可以在网上搜索markdown找到很多教程。这里是简书的官方教程


结语

依赖于GitHub社区,GitBook很可能成为新的通用工具。但由于被墙也就并不推荐普通用户使用。

如果需要的话可以优先考虑国内的看云kanCloud.


致力于让一切变得简单

如果您发现文章错误,请不吝留言指正;
如果您觉得有用,请点喜欢;
如果您觉得很有用,欢迎转载~


END

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容

  • 中午的肯德基餐厅,人不是太多。几个孩子吵吵嚷嚷的在点餐。看样子是刚考完试,要为其中一个小男生庆祝生日。几个人合计要...
    向晚的微风阅读 510评论 4 3
  • 人物:渴望创业大学生:A 同学1 同学2,父亲,母亲 每天早上6点,闹钟一如既往响起来打断人们的美梦,A醒得却比...
    西西西濛阅读 248评论 0 0