博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
GitBook 之旅
阅读量:7118 次
发布时间:2019-06-28

本文共 2065 字,大约阅读时间需要 6 分钟。

hot3.png

GitBook 之旅

为了方便管理,查阅.md文档,决定订册成书,使用 GitBook 生成静态网站,方便随意部署。

GitBook 已经非常出名,不再多复述,下面列出常用官方地址:

安装

安装其实很简单,不再复述,查阅官方文档内说明即可,并且不用担心因为版本的问题,出现的各种原因!

本文撰写版本为:3.2.3

基本目录结构

*默认必须要的文件。

.						// 根目录├── book.json           // 配置文件,默认没有,需要新建├── README.md           // * 对应书的前言说明├── SUMMARY.md			// * 对应目录,用插件自动生成├── chapter-1/          // 子级文件夹|   ├── README.md       // 子级文件夹说明,如果没有该文件,子页面无介绍,不可点击|   └── 1.md    		// 子页面└── chapter-2/    ├── README.md    └── 1.md

基本命令

  1. 安装完成,可以初始化一个模版,可以查看基本目录

    $ gitbook init
  2. 编译,并启动http服务,可在浏览器内预览

    $ gitbook serve
  3. 只进行编辑输出

    $ gitbook build
  4. 安装插件

    $ gitbook install

配置文件

记录Gitbook的一些基本配置信息。

title-设置书本的标题

{"title" : "Gitbook Use"}

author-作者的相关信息

{"author" : "zhangjikai"}

description-本书的简单描述

{"description" : "本书的简单描述"}

language-使用的语言

{"language" : "zh-hans"}

root-指定存放 GitBook 文件(除了 book.json)的根目录

{"root": "."}

links-在左侧导航栏添加链接信息

{    "links" : {        "sidebar" : {            "Home" : "http://xxx.com"        }	}}

plugins-配置使用的插件

*设置完成后,记得执行安装命令

{    "plugins": [    	"fontsettings"	]}

pluginsConfig-配置插件的属性

*设置完成后,记得执行安装命令

{    "pluginsConfig": {        "fontsettings": {            "theme": "sepia",            "family": "serif",            "size":  1        }    }}

插件

丰富的插件才能构建出功能强大的GitBook。下面列表为实测可用插件。

summary 目录自动生成

{    "plugins": [        "summary"	]}

search-plus 搜索插件

支持中文!

{    "plugins": [        "-lunr",        "-search",        "search-plus"	]}

advanced-emoji ?表情支持

?

{    "plugins": [        "advanced-emoji"	]}

Splitter 使侧边栏的宽度可以自由调节

{    "plugins": [        "splitter"    ]}

Mermaid-gb3 支持渲染Mermaid图表

{    "plugins": [        "mermaid-gb3"    ]}

tbfed-pagefooter 页面添加页脚

{    "plugins": [       "tbfed-pagefooter"    ],    "pluginsConfig": {        "tbfed-pagefooter": {            "copyright":"Copyright © xx.com 2019",            "modify_label": "该文件修订时间:",            "modify_format": "YYYY-MM-DD HH:mm:ss"        }    }}

copy-code-button 为代码块添加复制的按钮

{    "plugins": ["copy-code-button"]}

anchor-navigation-ex-toc 右侧页面导航条与回滚到顶部

{    "plugins": ["anchor-navigation-ex-toc"]}

转载于:https://my.oschina.net/u/3756690/blog/3022774

你可能感兴趣的文章
ASP.NET MVC中,通用的异常处理
查看>>
XtremSW缓存技术简介
查看>>
autorelease
查看>>
某网贷平台遭受***
查看>>
solidity 复杂类型的Data_Location
查看>>
Laravel 问题相关记录
查看>>
python里面__name__ = '__main__'的意思
查看>>
PHP的传值赋值和引用赋值的区别
查看>>
小程序跳转问题
查看>>
Ambari 2.4 安装教程,另附配置 haodoop lzo
查看>>
Python基础-Python基础使用
查看>>
自动化运维工具ansible的简单使用
查看>>
哈利波特图片
查看>>
PowerShell 获取磁盘使用情况
查看>>
右击本地连接属性“出现意外错误”解决办法
查看>>
我的友情链接
查看>>
VMware Vsphere6.0的功能及版本升级方式介绍
查看>>
RAID 技术基础知识
查看>>
java 8 移除 Premgen区
查看>>
路由器密码破解
查看>>