美文网首页技术
gitbook 创建书籍

gitbook 创建书籍

作者: 老柿子 | 来源:发表于2019-08-10 13:06 被阅读0次

这里采用github和gitbook关联的方式,文档都放在github上面,平常上库只需要将当前的文档上库到github,然后gitbook会自动的生效。

一、github中创建对应仓库的文档库

注意:github中的私有仓库,在gitbook中也会变成私有,因此如果向外部其他人看,尽量使用public仓库

二、创建团队

目前一个团队内部只能创建一个默认的公共空间,因此如果想要发布多个仓库文档,则可以采用创建多个团队的方式。


image.pngimage.png

三、创建空间

<img src = "https://img.haomeiwen.com/i2773022/d4688d1c34c54285.png&originHeight=480&originWidth=766&size=28041&status=done&width=383?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" size="180px">

四、创建项目

image.pngimage.png

添加跟github中的文档项目的关联


image.pngimage.png 选择同步的分支(以后github发布完成之后,gitbook会自动的进行部署,特别方便)<br /> image.pngimage.png 等待一会儿就可以了<br /> image.pngimage.png

五、编写

上面的关联完成之后,我们就可以欢快的在github中提交我们的文档了,那么文档格式是什么呢,这里就又用到了github了。

1.安装gitbook包

npm install gitbook-cli -g

注意:<br />如果没有安装npm,则先安装:

brew install nodejs

2.测试是否安装ok

gitbook -v

3.初始化gitbook

我们拉取github空仓库到本地

git clone git@github.com:SimonAlong/Neo_doc.git

因为关联了gitbook,因此该空仓库中有这么两个文件(README.md,SUMMARY.md)<br />readme.md就是首页的markdown<br />summary.md就是对应的左边的目录

4.编写自己的目录

要生成自己的做个章节那种树形的目录,我们可以通过gitbook中的命令执行,但是该命令也支持读取summary.md文件,我们先在目录中编写我们的目录,然后调用如下命令,就可以直接生成目录树了

gitbook init

比如summary.md

* [简介](README.md)
* [一、类介绍](usageCls/README.md)
    * [一个类](usageCls/oneClass.md)
    * [两种函数](usageCls/twoFun.md)
    * [三种注解](usageCls/threeAnno.md)
* [二、匹配器](matcher/README.md)
    * [values](matcher/values.md)

5.本地测试

当将上面的子目录中的文件都编写完成,则我们就可以发布了,我们如果想看下效果,那么就可以进行本地测试

gitbook serve

http://localhost:4000<br />执行即可打开默认端口4000,想换端口可以采用

gitbook serve -p 8888 .

六、发布

当将上面的都执行完,直接推送到github即可,然后就可以去查看我们的gitbook对应的url了,那么这个url在哪里呢,在这里<br /> image.pngimage.png

其中该url就是可以直接对外访问的url,以后就可以通过这个来进行分享使用

相关文章

  • gitbook 创建书籍

    这里采用github和gitbook关联的方式,文档都放在github上面,平常上库只需要将当前的文档上库到git...

  • mdBook使用

    mdBook和GitBook一样,可以通过markdown文件创建书籍,它是用Rust实现。 github链接:h...

  • gitbook Published with GitBook 隐

    刚创建的gitbook如下 去除/修改Published with GitBook 在项目中创建_layouts-...

  • GiBbook实用配置以及插件使用

    GitBook可以在您的计算机上用于构建本地书籍,,可以本地预览 安装gitbook 环境要求:安装GitBook...

  • 创建gitbook项目

    前言项目中的文档想以gitbook的形式展示出来,那么如何初始化一个gitbook的项目呢? 其实很简单,只需要三...

  • 如何搜索gitbook书籍

    1.利用site命令在gitbook.com搜书图书 有的书籍搜索到的是旧版gitbook里面的,直接下载pdf即可

  • 刘月林 GitBook 安卓下载

    GitBook阅读器 使用ReactNative开发的GitBook阅读器,可以查看在线的书籍信息,在线阅读和下载...

  • 使用GitBook工具生成PDF格式的文档

    GitBook安装和使用 前提 我们想使用GitBook工具对github等网站的开源书籍生成PDF文件环境 ub...

  • GitBook使用

    GitBook的安装教程网上随手可以查到很多,我就不重复了。 安装好GitBook之后,就可以开始做自己的书籍。 ...

  • Gitbook详解(二)-命令行的使用

    命令行的使用 Gitbook 的命令行工具其实就是 gitbook-cli ,可以通过命令的方式来创建,构造,安装...

网友评论

    本文标题:gitbook 创建书籍

    本文链接:https://www.haomeiwen.com/subject/vgqrjctx.html