文档章节

Gitbook-Ext 修改Gitbook模板

漆工
 漆工
发布于 2015/10/07 12:39
字数 525
阅读 2230
收藏 4

Gitbook-Ext

GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 并非关于 Git 的教程。

GitBook 提供的的默认样式可能不能满足您的视觉需求,Gitbook-Ext是对GitBook的扩展,并陆续会提供一些更丰富的模板选择。

扩展功能

  • 提供多种色彩模板选择:theme-green,theme-purple,theme-orange,theme-gray;
  • 提供菜单可折叠配置;
  • 提供是否生成菜单序号配置;
  • 提供标题与版权信息设置。

电脑上的效果

image

手机上的效果

image

预览效果 http://f2edocs.com/

快速开始

安装GitBook

首先你需要先安装nodejs/npm, 然后在安装gitbook 通过以下命令就可以安装

$ npm install gitbook-cli -g

gitbook具体详细可以参考 https://github.com/GitbookIO/gitbook

安装Gitbook-Ext

npm install gitbook-ext -g

查看帮助

gitbook-ext -h

会列出以下信息

Usage: index [options]

 Options:

   -h, --help      output usage information
   -V, --version   output the version number
   -d, --default   default template
   -p, --pagurian  pagurian template

使用模板

初始化模板信息

gitbook-ext -i

你也可以手动创建以下文件

├── book.json
├── README.md
└── SUMMARY.md

book.json 这个文件可以配置模板参数

{
    "variables": {
        "title": "前端工程师文档",
        "theme": "theme-gray",
        "copyright": "Copyright 2015 f2edocs.com"
    },
    "collapsible_menu":true,
    "level_number":false,
    "links": {
        "gitbook": false,
        "sharing": {
            "all":false,
            "vk": false,
            "facebook": true,
            "twitter": true,
            "google": true,
            "weibo": true
        }

    }
}
  • variables-title: 配置文档标题,显示在页面顶部;
  • variables-theme: 模板颜色,当前支持:theme-green,theme-purple,theme-orange;
  • variables-copyright: 配置版权信息,显示在页面底部;
  • collapsible_menu: 使用折叠菜单;
  • level_number: 使用菜单结构序号;
  • links: 开启一些连接.

切换你需要使用的模板 比如使用pagurian模板

gitbook-ext -p

当配置完成以后,执行以下命令,就默认生成了一个_book文件

gitbook build

如果你想切换到默认的模板,执行以下命令

gitbook-ext -d
gitbook build

谁在用

http://f2edocs.com/

© 著作权归作者所有

漆工
粉丝 12
博文 11
码字总数 10768
作品 1
杨浦
前端工程师
私信 提问
GitBook - 快速打造可留言的博客

Create by jsliang on 2019-05-20 14:43:41 Recently revised in 2019-05-22 18:01:09 本文将介绍如何安装 GitBook、如何起 GitBook 服务、如何配置 GitBook,以及到最后的部署到 GitHub Pag...

jsliang
05/22
0
0
用 Github、Markdown 和 GitBook 写开源书

原文同步至:http://www.waylau.com/using-github-markdown-gitbook-write-open-source-books/ 之前一直是在 Github 上写开源书(见:http://www.waylau.com/books/)但,由于 Github 本身的......

waylau
2014/12/11
11.4K
3
gitlab利用ci自动部署gitbook的问题

最近部署了一个gitlab和gitbook,利用gitlab的gitrunner来自动化管理gitbook,但是遇到了问题,编写了.gitlab-ci.yml脚本,内容如下: 然后写了一个启动脚本,大致内容就是先检测gitbook ser...

T2phageBy
07/16
236
0
GitBook快速教程 1.3 电子书导出

版权声明:本文为twowinter原创文章,请联系微信公众号twowinter,未经博主允许不得转载。 https://blog.csdn.net/iotisan/article/details/81121218 这是一个 gitbook 教程,介绍如何基于模...

iotisan
2018/07/19
0
0
Gitbook : random errors when using gitbook plugin on running "gitbook serve"

在执行时,会有不定的失败错误 参考问题 :#1309 解决方案:更新gitbook版本,这个问题似乎是3版本的问题 , 官方也不打算在这个版本解决了。 更新 到最新版本后, 不再出现问题了。 列出所有...

ol_O_O_lo
2018/12/19
19
0

没有更多内容

加载失败,请刷新页面

加载更多

java通过ServerSocket与Socket实现通信

首先说一下ServerSocket与Socket. 1.ServerSocket ServerSocket是用来监听客户端Socket连接的类,如果没有连接会一直处于等待状态. ServetSocket有三个构造方法: (1) ServerSocket(int port);...

Blueeeeeee
52分钟前
5
0
用 Sphinx 搭建博客时,如何自定义插件?

之前有不少同学看过我的个人博客(http://python-online.cn),也根据我写的教程完成了自己个人站点的搭建。 点此:使用 Python 30分钟 教你快速搭建一个博客 为防有的同学不清楚 Sphinx ,这...

王炳明
昨天
4
0
黑客之道-40本书籍助你快速入门黑客技术免费下载

场景 黑客是一个中文词语,皆源自英文hacker,随着灰鸽子的出现,灰鸽子成为了很多假借黑客名义控制他人电脑的黑客技术,于是出现了“骇客”与"黑客"分家。2012年电影频道节目中心出品的电影...

badaoliumang
昨天
13
0
很遗憾,没有一篇文章能讲清楚线程的生命周期!

(手机横屏看源码更方便) 注:java源码分析部分如无特殊说明均基于 java8 版本。 简介 大家都知道线程是有生命周期,但是彤哥可以认真负责地告诉你网上几乎没有一篇文章讲得是完全正确的。 ...

彤哥读源码
昨天
14
0
jquery--DOM操作基础

本文转载于:专业的前端网站➭jquery--DOM操作基础 元素的访问 元素属性操作 获取:attr(name);$("#my").attr("src"); 设置:attr(name,value);$("#myImg").attr("src","images/1.jpg"); ......

前端老手
昨天
6
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部