GitBook新手入门

2024-05-02 14:18
文章标签 新手入门 gitbook

本文主要是介绍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会自动转成当前文件所在目录的相对目录。所以我推荐将图片保存在当前文件所在目录下面,然后文件中图片的地址直接使用图片名称即可(图片相对于当前文件所在路径)。
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的任何细节了。

参考资料

  • GitBook Toolchain Documentation

这篇关于GitBook新手入门的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/954440

相关文章

新手入门容器及微服务必看的大咖分享

新手入门容器及微服务必看的大咖分享 在快速变化的市场环境下,无论是新兴互联网行业还是传统行业都面临着敏捷开发的需求,要求应用快速开发、持续迭代、灵活部署和弹性伸缩,因此对应用进行微服务化以及开发运维一体化和管理框架的建设成为企业 IT 建设和管理的新焦点;而容器平台为微服务提供了恰当而高效的运行环境,也是云计算服务的有机延伸。 在此背景下,企业 IT 部门需要关注如下话题:如何选择容器平台、如

SpringBoot 新手入门(实操)

Spring Boot 是一个开源框架,旨在简化基于 Spring 的 Java 应用程序的开发。它通过提供一系列默认配置和约定大于配置的理念,让开发者可以更快速地创建和部署应用。以下是一个 Spring Boot 新手入门的实操指南,帮助你从零开始创建一个简单的 Spring Boot 应用程序。 环境准备 安装 JDK: Spring Boot 需要 Java Development K

PyCharm新手入门指南_pycharm怎么开始编程_PyCharm使用教程!

Pycharm 作为一款针对 Python 的编辑器,配置简单、功能强大、使用起来省时省心,对初学者友好,本文我们将介绍 pycharm 编辑器的基本使用方法, 安装好Pycharm后,就可以开始编写第一个函数:Hello World啦~我们就先来学习一些基本的操作,主要包含新建Python文件,运行代码,查看结果等等。 如果不会安装PyCharm的可以参考这篇文章:PyCharm下载安装教程

[新手入门]1台电脑+1个电视+2个软件(sunshine+moonlight) 解决黑神话悟空没有hdmi线的痛...

sunshine+moonlight 解决黑神话悟空 本地串流投屏 背景:偶然间在B站发现了sunshine+moonlight方案,替代hdmi线,做本地串流...于是心灵手巧的我开始尝试踩坑之路:1.准备安装包2.开始安装2.1 笔记本windows安装sunshine2.2 遇到了第一个坑.Fatal: ViGEmBus is not installed or running. You

迷雾大陆辅助:VMOS云手机助力新手入门!玩法机制大全!

在《迷雾大陆》的神秘世界中,玩家们总是面临着层层挑战,而使用VMOS云手机能够极大地提升你的游戏体验。VMOS云手机专门为《迷雾大陆》打造了定制版云手机,内置游戏安装包,玩家无需重新下载安装,直接畅玩。此外,VMOS云手机支持24小时云端运行,帮助你轻松完成日常任务和活动,解放双手。更令人惊喜的是,VMOS云手机还能实现无限多开,无论你是想同时操作多个账号,还是在不同设备上无缝衔接,VMO

dll错误修复工具:一键解决系统DLL错误产生的程序问题(新手入门)

dll错误修复工具,主要解决导致Windows系统上程序出错的各种dll相关问题。金舟DirectX·DLL一键修复提供了全面的且快速的扫描功能,能够检测出导致程序故障的任何dll错误,并且一键进行修复。 一、什么是dll文件 dll是系统的动态链接库文件,主要用于支持某些软件、游戏的启动和运行。如果系统中缺少了这个文件,相应的软件或游戏可能就无法正常打开和运行 二、什么是dll错误

《黑神话:悟空》新手入门攻略,全方位解析!

黑神话:悟空》是一款基于中国经典神话《西游记》改编的动作角色扮演游戏,玩家将在游戏中化身为大圣,踏上一段充满挑战与神秘的冒险旅程。对于新手玩家来说,了解游戏的基础玩法是顺利进入这个奇幻世界的关键。下面为大家带来《黑神话:悟空》的新手入门攻略,帮助你快速掌握游戏技巧,享受这场精彩的西游之旅。 1. 战斗属性解析:了解角色的基础能力 在《黑神话:悟空》中,角色的战斗属性决定了你的生

解决GitBook RangeError: Maximum call stack size exceeded

问题描述 在编写Gitbook的过程中,在启动gitbook serve预览的时候,发生了错误RangeError: Maximum call stack size exceeded。 解决方案 https://github.com/GitbookIO/plugin-lunr/blob/master/README.md#limitations l

解决GitBook不支持[TOC]生成的本页目录

问题如下 在编写GitBook的过程中,不可能避免有些篇章会篇幅比较长,此时就会想到markdown有个[TOC]可以生成目录。 但是在使用GitBook运行服务gitbook serve打开页面的时候,却是不支持的,如下图: 正常文档中的显示如下: 那么有没有什么好办法去处理呢? 解决方法 发现Github的一个项目https://githu

AI绘画stable diffusion 模型介绍及下载、使用方法,超全的新手入门教程建议收藏!

大家好,我是画画的小强 今天我将继续分享AI绘画Stable Diffusion的模型、参数含义等,分享给各位朋友一起学习。 一、模型 Stable difusion 模型就是所谓的大模型,用来控制整个画面的风格走势的。 打开webui页面,可以看到大模型一般2G以上,大部分后缀为.safetensors或.ckpt,如图: 大模型一般保存文件夹路径如下: 大小为2-7G不等(也就是