GitBook介绍安装和使用教程

麦田4年前 (2019-10-03)工作笔记867

GitBook介绍


GitBook和hugo、hexo类似,但侧重于生成电子书,项目说明等内容!


1、安装 Node.js

GitBook 是一个基于 Node.js 的命令行工具,安装Node.js后,用以下命令检查是否安装成功!本人的Win10电脑之前安装hexo时已经安装过:Win10系统安装Hexo教程


右键点击开始菜单,再点击命令提示符(管理员),显示如下:


C:\WINDOWS\system32>

输入:node -v

显示:v10.16.3 # 这是版本号,表示已经安装成功


附注,如果点击命令提示符,会显示C:\Users\电脑用户名,比如zhang>

2、安装 GitBook

输入命令安装 GitBook:install gitbook-cli -g,检验是否安装成功:


$ gitbook -V

CLI version: 2.3.2

GitBook version: 3.2.3

3、GitBook常用命令

新建项目:在D盘新建文件夹,在文件夹内打开命令行:gitbook init


预览项目:gitbook serve


预览网址:http://localhost:4000/


生成静态网站:gitbook build

4、GitBook的文件介绍

新建项目后,在文件夹内会创建 README.md 和 SUMMARY.md,README.md 是说明文档,SUMMARY.md 是书的章节目录,示例如下:


# Summary


* [本书介绍/前言](README.md)


## 第一章


* [第一节](1001.md)

* [第二节](1002.md)


## 第二章/Part II


* [第一节](2001.md)

* [第二节](2002.md)


---


* [结语](title.md)

普通写法如下


# Summary


# Part I


* [Introduction](README.md)

* [Writing is nice](part1/writing.md)

* [GitBook is nice](part1/gitbook.md)


# Part II


* [We love feedback](part2/feedback_please.md)

* [Better tools for authors](part2/better_tools.md)


---


* [Last part without title](part3/title.md)

5、配置文件book.json

这个文件需要自己新建,并放在根目录下,示例如下


{

    "author": "作者名字",

    "description": "描述",

    "extension": null,

    "generator": "site",

    "isbn": null,

    "links": {

        "sharing": {

            "all": null,

            "facebook": null,

            "google": null,

            "twitter": null,

            "weibo": null

        },

        "sidebar": {

            "链接": "http://www..com"

        }

    },

    "output": null,

    "pdf": {

        "fontSize": 16,

        "footerTemplate": null,

        "headerTemplate": null,

        "margin": {

            "bottom": 36,

            "left": 62,

            "right": 62,

            "top": 36

        },

        "pageNumbers": false,

        "paperSize": "a4"

    },

    "plugins": [],

    "title": "书名",

    "variables": {}

}

6、GitBook主题和插件

GitBook的默认主题是黑白色,非常简洁,已经很完美,她还有彩色主题可以选择;


GitBook默认自带五个插件,可以禁用,也可以下载使用更多插件!

相关文章

Win10系统安装Hugo详细教程

Hugo是主流的静态网站生成器,也叫静态博客生成器。hugo是在本地运行的软件,在本地电脑按照规定格式写好文章,然后通过hugo可以一键生成一个优秀的网站!Hugo生成的网站是目前最新的自适应性网站,...

Hugo基于标签展示相关文章

本文以主题rockrock为例讲解:使用dw打开模板文件:themes/主题rockrock/layouts/_default/single.html找到以下内容:</div> ...

Hugo主题ivy的配置

Hugo主题ivy特别简洁,首页文章列表只有标题。主题文件也很简单,内容清晰,网站加载速度极快,这点比Hugo主题beautiful好很多!我在优化这个主题中遇到的问题如下:1、善用exampleSi...

Hugo主题nuo的配置

Hugo主题nuo简洁大方,电脑端界面分左右两栏,手机端界面和其他所有主题类似,我很喜欢!因为麦田喜欢生成.html文件,并直接放在网站根目录下,所以这个主题修改和配置的地方比较多:1、先设置网站根目...

Hugo主题maupassant的配置

编辑优化Hugo主题maupassant的经验因为在config.toml文件中添加了uglyurls = “true” ,生成的文件都是html格式,而不是默认的目录,所以就需要修改其他参数,比如标...

Hugo主题mainroad的配置

hugo主题模板mainroad源自WordPress主题 Mainroad,原作者是MH Themes,不得不说WordPress的主题最丰富,优秀作品也多。2020年2月20日优化:1、优化全部标...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。