GitBook新手入门

本文涉及的产品
智能开放搜索 OpenSearch行业算法版,1GB 20LCU 1个月
实时计算 Flink 版,1000CU*H 3个月
实时数仓Hologres,5000CU*H 100GB 3个月
简介: GitBook是使用Git管理书籍项目,使用Markdown撰写书籍,并使用GitHub和GitBook网站进行托管的一个实用工具。下面简单说一下新手如何使用该强大的工具。

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文本文件。

   - [前言](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会自动转成当前文件所在目录的相对目录。所以我推荐将图片保存在当前文件所在目录下面,然后文件中图片的地址直接使用图片名称即可(图片相对于当前文件所在路径)。

  1. 在线预览

    gitbook serve

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

发布到GitHub和GitBook

这里通过将工程同步到GitHub上,然后通过GitHub和GitBook的同步完成

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

参考资料

目录
相关文章
|
Java 数据库连接 Nacos
nacos常见问题之Nacos2.0.3集群模式启动报错如何解决
Nacos是阿里云开源的服务发现和配置管理平台,用于构建动态微服务应用架构;本汇总针对Nacos在实际应用中用户常遇到的问题进行了归纳和解答,旨在帮助开发者和运维人员高效解决使用Nacos时的各类疑难杂症。
|
存储 关系型数据库 MySQL
轻松入门MySQL:数据库设计之范式规范,优化企业管理系统效率(21)
轻松入门MySQL:数据库设计之范式规范,优化企业管理系统效率(21)
322 0
|
10月前
|
存储 Shell Linux
Linux 如何更改默认 Shell
Linux 如何更改默认 Shell
Linux 如何更改默认 Shell
|
存储 算法 计算机视觉
Baumer工业相机堡盟工业相机软件CameraExplorer常见功能使用说明二
Baumer工业相机堡盟工业相机软件CameraExplorer常见功能使用说明二
260 0
|
JavaScript
文档工具GitBook使用指南
这篇博客提供了GitBook的安装和使用指南,包括如何在本地安装Node.js和GitBook、初始化GitBook项目、生成HTML和电子书格式(PDF、mobi)的文档,以及推荐的相关阅读资源。
534 8
文档工具GitBook使用指南
|
运维 Kubernetes 监控
备战双 11!蚂蚁金服万级规模 K8s 集群管理系统如何设计?
备战双 11!蚂蚁金服万级规模 K8s 集群管理系统如何设计?
|
安全
全面人机协同系统的理论框架
【1月更文挑战第20天】全面人机协同系统的理论框架
1002 1
全面人机协同系统的理论框架
|
存储 编译器 程序员
【C++ 泛型编程 高级篇】 C++ 14 模版元编程 遍历元组 编译期生成整数序列 std::index_sequence和std::make_index_sequence 使用指南(一)
【C++ 泛型编程 高级篇】 C++ 14 模版元编程 遍历元组 编译期生成整数序列 std::index_sequence和std::make_index_sequence 使用指南
695 0
|
NoSQL 测试技术 Linux
Golang 单元测试合集整理,(我最常用 gomonkey)欢迎收藏
Golang 单元测试合集整理,(我最常用 gomonkey)欢迎收藏
301 1
|
自然语言处理 编译器 C语言
一文搞懂模板(template)
背景引入: 想象一下,我们要实现一个整数相加,浮点数相加的函数,如果按C语言的思路,我们需要写两个函数名不同的函数,来完成相加;如果C++语言,则可以通过函数重载的特性,写两个函数名相同,但参数列表不同的函数,来完成任务。
335 0