前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >GitBook新手入门

GitBook新手入门

作者头像
卡尔曼和玻尔兹曼谁曼
发布2019-01-22 10:23:55
1.1K0
发布2019-01-22 10:23:55
举报

GitBook新手入门

GitBook是使用Git管理书籍项目,使用Markdown撰写书籍,并使用GitHub和GitBook网站进行托管的一个实用工具。下面简单说一下新手如何使用该强大的工具。

创建Gitbook账户

  1. 首先去GitBook注册一个账号
  2. 然后在账号中新建一个Organzation(组织)
  3. 在该组织中新建一个Space(一般一个Space包含一本书,一个组织中可以创建多个Space)

命令行工具安装

  1. 安装Node.js 可以使用node -v检测是否安装成功
  2. 使用npm包管理工具安装GitBook命令行工具 npm install gitbook-cli -g 可以使用gitbook -V检测是否安装成功

书籍编辑

  1. 初始化书籍样本文件(切换到撰写的书籍目录下,执行如下命令) gitbook init 该命令会自动创建SUMMARY.md和README.md。README.md中书写对本书的介绍,SUMMARY.md是本书的目录。 如果提前创建好这两个文件,在执行上面的命令,则该命令会按照SUMMARY.md文件中设置的目录格式自动创建书籍的目录。 例如,如果提前建立好如下的SUMMARY.md目录文件,则会根据文件中的路径自动创建书籍文件夹及文件中的markdown文本文件。
代码语言:javascript
复制
   - [前言](README.md)
   - [Python基础](Python基础/README.md)
     - [Python环境搭建及基本数据类型](Python基础/Python环境搭建及基本数据类型.md)
     - [运算符及字符串](Python基础/运算符及字符串.md)
     - [序列与字典](Python基础/序列与字典.md)
     - [流程控制语句](Python基础/流程控制语句.md)
     - [函数](Python基础/函数.md)
     - [面向对象编程初识](Python基础/面向对象编程初识.md)
     - [面向对象编程高级](Python基础/面向对象编程高级.md)
     - [Python科学计算](Python基础/Python科学计算.md)
     - [空间数据处理环境搭建](Python基础/空间数据处理环境搭建.md)
   - [空间数据基础](空间数据基础/README.md)
     - [空间参考系统](空间数据基础/空间参考系统.md)
     - [地图投影](空间数据基础/地图投影.md)
     - [空间数据](空间数据基础/空间数据.md)

书籍的撰写可以采用任何markdown编辑器,我个人比较推荐Typora,当然也可以使用GitBook官方的GitBook Editor。

需要注意的是撰写过程中插入的图片地址,GitBook会自动转成当前文件所在目录的相对目录。所以我推荐将图片保存在当前文件所在目录下面,然后文件中图片的地址直接使用图片名称即可(图片相对于当前文件所在路径)。 2. 在线预览

gitbook serve

执行该命令以后在浏览器打开http://localhost:4000,可以进行书籍的预览

发布到GitHub和GitBook

这里通过将工程同步到GitHub上,然后通过GitHub和GitBook的同步完成 1. 首先在GitHub上新建一个Repository,然后将本地工程同步到该仓库,具体步骤参间我的博文:新建Git仓库并添加本地项目 2. 然后在GitBook新建的Space中Integrations中关联GitHub上的该仓库即可。 这样子,每次使用Git命令同步文件到GitHub后,GitBook也会自动同步。其实,就是一个Git项目,不用操心GitBook的任何细节了。

参考资料

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2018年04月28日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • GitBook新手入门
    • 创建Gitbook账户
      • 命令行工具安装
        • 书籍编辑
          • 发布到GitHub和GitBook
            • 参考资料
            相关产品与服务
            命令行工具
            腾讯云命令行工具 TCCLI 是管理腾讯云资源的统一工具。使用腾讯云命令行工具,您可以快速调用腾讯云 API 来管理您的腾讯云资源。此外,您还可以基于腾讯云的命令行工具来做自动化和脚本处理,以更多样的方式进行组合和重用。
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档