侧边栏壁纸
博主头像
落叶人生博主等级

走进秋风,寻找秋天的落叶

  • 累计撰写 130562 篇文章
  • 累计创建 28 个标签
  • 累计收到 9 条评论
标签搜索

目 录CONTENT

文章目录

gitbook使用

2023-11-30 星期四 / 0 评论 / 0 点赞 / 77 阅读 / 6028 字

初始化一本书,名字叫 mybook(如果不写名字,默认生成_book的书名) 命令格式:gitbook init 书名 gitbook init mybook 使用命令gitbook init,则生成

 

初始化一本书,名字叫 mybook(如果不写名字,默认生成_book的书名)

命令格式:gitbook init 书名

gitbook init mybook

使用命令gitbook init,则生成一系列目录文件,见下方;

[lsug@minion mybook]$ tree .
.
├── book
│   ├── editor.md
│   ├── gitbook-cli.md
│   └── README.md
├── end
│   └── README.md
├── howtouse
│   ├── gitbookcli.md
│   ├── gitbookinstall.md
│   ├── Nodejsinstall.md
│   └── README.md
├── output
│   ├── outfile.md
│   ├── pdfandebook.md
│   └── README.md
├── publish
│   ├── gitbook.md
│   ├── github.md
│   ├── gitpages.md
│   └── README.md
├── README.md
└── SUMMARY.md

5 directories, 17 files

每个目录中,都有一个README.md文件,相当于一章的说明。

 

使用Gitbook的命令行进行本地预览

命令格式:gitbook serve ./图书名称

[lsug@minion devops]$ gitbook serve ./mybook
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed 
info: loading plugin "livereload"... OK 
info: loading plugin "highlight"... OK 
info: loading plugin "search"... OK 
info: loading plugin "lunr"... OK 
info: loading plugin "sharing"... OK 
info: loading plugin "fontsettings"... OK 
info: loading plugin "theme-default"... OK 
info: found 1 pages 
info: found 0 asset files 
info: >> generation finished with success in 1.6s ! 

Starting server ...
Serving book on http://localhost:4000

然后浏览器中输入 http://localhost:4000 或者http://172.16.1.81:4000就可以预览生成的以网页形式组织的书籍。

 

执行gitbook build 命令会生成静态网站

命令格式:gitbook build 图书目录   输出目录

[lsug@minion devops]$ gitbook  build   (可以指定输出目录)
info: 7 plugins are installed 
info: 6 explicitly listed 
info: loading plugin "highlight"... OK 
info: loading plugin "search"... OK 
info: loading plugin "lunr"... OK 
info: loading plugin "sharing"... OK 
info: loading plugin "fontsettings"... OK 
info: loading plugin "theme-default"... OK 
info: found 1 pages 
info: found 0 asset files 
info: >> generation finished with success in 1.1s ! 

这里你会发现,你在你的图书项目的目录中多了一个名为_book的文件目录,而这个目录中的文件,即是生成的静态网站内容。

3-输出PDF

输出为PDF文件,需要先使用NPM安装上gitbook-pdf:

 sudo npm install gitbook-pdf -g (安装会报错,phantomjs包没有安装)

进入目录,生成pdf文档

cd /data/gitbook/devops

gitbook pdf . 

解决报错

export PHANTOMJS_CDNURL=http://cnpmjs.org/downloads npm install phantomjs

npm install -g phantomjs

 

查看帮助

[root@minion gitbook]# gitbook --help

  Usage: gitbook [options] [command]
  Commands:

    ls                        List versions installed locally
    current                   Display currently activated version
    ls-remote                 List remote versions available for install
    fetch [version]           Download and install a <version>
    alias [folder] [version]  Set an alias named <version> pointing to <folder>
    uninstall [version]       Uninstall a version
    update [tag]              Update to the latest version of GitBook
    help                      List commands for GitBook
    *                         run a command with a specific gitbook version

  Options:

    -h, --help               output usage information
    -v, --gitbook [version]  specify GitBook version to use
    -d, --debug              enable verbose error
    -V, --version            Display running versions of gitbook and gitbook-cli
 

书籍编辑:

gitbook书籍编辑有两种方法:

    a-gitbook命令行

    b-markdown编辑

README.md和SUMMARY.md是Gitbook项目必备的两个文件;

README.md:这个文件相当于一本Gitbook的简介,最上层(和SUMMARY.md同级)的是本书的Introduction

SUMMARY.md:这个文件是一本书的目录结构,使用Markdown语法, 这个文件在使用gitbook命令行之前要先写好,以便之后生成书籍目录

 

广告 广告

评论区