gitbook第一站，看看如何搭建使用

本该努力的年龄千万别放弃
469 阅读3分钟

「这是我参与2022首次更文挑战的第23天，活动详情查看：2022首次更文挑战」

Gitbook是一个命令行工具，可以把你的Markdown文件汇集成电子书，并提供PDF等多种格式输出。你可以把Gitbook生成的HTML发布出来，就形成了一个简单的静态网站。Gitbook还有一个同名的平台（gitbook.io），可以发布和销售电子书，并提供了一个Markdown客户端工具（支持Mac、Windows和Linux）帮助写作。以下是我在使用Gitbook中的笔记。

首先Gitbook和Git/Github都没有什么关系。它只是一个build book的工具而已。但它的Git前缀的确引起了许多人的迷惑，起初我认为至少它也是个和Github类似的Git平台吧，但其实没什么关系，你只要懂几条markdown语法，不必理解任何与Git相关的东西就能用Gitbook了，不要为其名字迷惑。

前期准备

  • gitbook的安装和hexo一样，都是借助于node实现的。这里node的安装不细说，读者可以自行百度

gitbook安装

  • 我们安装gitbook-cli这个在安装好之后查看版本之后我们就可以安装gitbook。

npm install -g gitbook-cli

配置

  • 然后我们创建我们书籍数据 ，我这里将数据目录创建在oschina/gitbook/content中，在content中初始化我们主要下面两个文件。因为 笔者已经将目录生成好了，所以这里会多出很多目录。读者只需要创建途中圈中的两个文件就可以了。

初始化文件

  • README.md文件不用多做介绍，相当于一本书的简介。唯一注意的是需要用markdown格式的文件就行了
  • SUMMARY.md是我们书籍中的目录文件。 目录内容就根据自己需要编写。这里给一个模板
 ​
 # Summary
 ​
 * [简单介绍](README.md)
 * [第一章](chapter1/README.md)
    * [第一节](chapter1/section1.md)
    * [第二节](chapter1/section2.md)
 * [第二章](chapter2/README.md)
    * [第一节](chapter2/section1.md)
    * [第二节](chapter2/section2.md)
 * [结束](end/README.md)
 ​
 ​
 ​

  • 然后可以在oschina/gitbook/content文件夹中执行gitbook init初始化文件了。 初始化完成我们可以tree命令查看目录树结构

  • 执行完gitbook init之后gitbook 会根据目录文件中的配置生成文件的。

构建html文件并发布服务

  • 因为我是讲源文件放在了content中。目的是最后在发布到gitee上好分支管理的时候
  • content目录下方的是源文件
  • doc目录下放的是构建好的HTML文件

构建

  • 在oschina/gitbook文件夹下执行命令

  • gitbook build ./content ./doc

  • 执行完上述命令我们会发现oschina/gitbook下多了一个doc文件夹。doc文件夹中是html文件，也是我们下面需要发布的文件

  • gitbook serve 就可以发布到本地服务了。执行完我们 localhost:4000 就可以看到效果。

  • 因为我结构已经改了，所以我们发布有所不一样 gitbook serve ./content ./doc

  • 如果没有content ，我们就可以在默认文件夹执行。总之一句话 readme.md和sumary.md文件在哪我们就在哪里

avatar
文章
阅读
粉丝