Gitbook 插件主题

文章目录

Gitbook 插件主题
- 1. theme-default 插件
- - 1.1 安装
  - 1.2 配置
  - 1.3 效果
- 2. theme-comscore 插件
- - 2.1 安装
  - 2.2 配置
  - 2.3 效果
- 3. theme-api 插件
- - 3.1 安装
  - 3.2 配置
  - 3.3 语法
  - 3.4 效果
  - 3.5 布局

1. theme-default 插件

theme-default 插件是默认主题,大多数插件针对的都是默认主题。

默认情况下,左侧菜单不显示层级属性,如果将 showLevel 属性设置为 true 可以显示层级数字.

1.1 安装

npm i gitbook-plugin-theme-default

1.2 配置


"pluginsConfig": {"theme-default": {"showLevel": true}
}"plugins": ["theme-default"]

1.3 效果

2. theme-comscore 插件

theme-default 插件默认主题是黑白的,而theme-comscore插件主题是彩色的,即标题和正文颜色有所区分.

2.1 安装

npm i gitbook-plugin-theme-comscorenpm i -g gitbook-cli // maybe need sudo permission
gitbook install

2.2 配置

{"plugins": ["theme-comscore"]
}

2.3 效果

3. theme-api 插件

使用 GitBook 发布 API 文档的主题。

theme-api 主题与搜索插件（如默认插件或algolia）完美配合。

3.1 安装

npm i gitbook-plugin-theme-api

3.2 配置

{"plugins": ["theme-api"],"pluginsConfig": {"theme-api": {"theme": "dark"}}
}

3.3 语法

该主题允许使用模板块语法轻松定义具有不同语言示例的方法。

一个方法块可以包含任意数量的嵌套sample和common块。

这些嵌套块记录在下面。

{% method %}
## Install {#install}The first thing is to get the GitBook API client.{% sample lang="js" %}
```bash
$ npm install gitbook-api

{% sample lang=“go” %}

$ go get github.com/GitbookIO/go-gitbook-api

{% endmethod %}


在每个包含示例块的页面上，右上角method会自动添加一个切换器，以轻松选择要显示的语言。可以在book.json文件中配置每种语言的名称，其lang属性对应于sample块lang参数：```bash
{"plugins": ["theme-api"],"pluginsConfig": {"theme-api": {"languages": [{"lang": "js",          // sample lang argument"name": "JavaScript",  // corresponding name to be displayed"default": true        // default language to show},{"lang": "go","name": "Go"}]}}
}

3.4 效果

3.5 布局

该主题提供了两种布局来显示您的示例：一列或两列（拆分）。当"split": true时为拆分布局。

{"plugins": ["theme-api"],"pluginsConfig": {"theme-api": {"split": true}}
}

一栏布局

拆分布局

gitbook 插件主题相关推荐

gitbook 插件：Emoji 表情
gitbook 插件:Emoji 表情文章目录 gitbook 插件:Emoji 表情 1. advanced-emoji 插件 1.1 安装 1.2 配置 1.3 效果 1. advanced-e ...
gitbook 插件图标与LOGO
gitbook 插件:图标与LOGO 文章目录 gitbook 插件:图标与LOGO 1. custom-favicon 插件 1.2 安装 1.3 配置 1.4 效果 2. favicon 插件 2 ...
gitbook 插件赞赏
gitbook 插件赞赏文章目录 gitbook 插件赞赏 1. donate 打赏插件 1.1 安装 1.2 配置 1.3 效果 1. donate 打赏插件如果喜欢,请打赏 1.1 安装 ...
gitbook 插件 pdf
gitbook 插件 pdf 文章目录 gitbook 插件 pdf 1. pdf 插件 1.1 安装 1.2 导出 pdf 2. pdf-multi-link 插件 2.1 安装 2.2 配置 2. ...
sublime html主题,自用Sublime Text 插件主题配置大全
原则上收费的,但可以试用,试用期是免费的,在试用期间会提示你购买. package control 首先必须要介绍的就是这个,它是用来进行插件管理的,插件的安装.查看.删除都可以用package co ...
GitBook插件整理
介绍一下gitbook中book.json的一些实用配置和插件(book.json找不到可以在SUMMARY.md同级目录下新建一个) 1. 配置概况 1.1. 全局配置 title 设置书本的标题 ...
GitBook插件整理 - book.json配置
目录 1. 配置概况 1.1. 全局配置 1.2. 插件列表 plugins 1.3. 插件属性配置pluginsConfig 2. 一些实用插件 2.1. back-to-top-button 回到 ...
GitBook插件整理 - book.json
文章目录 1. 配置内容 1.1. 全局配置 1.2. 插件列表 plugins 1.3. 插件属性配置pluginsConfig 2. 一些实用插件 2.1. back-to-top-button ...
dokuwiki安装插件主题设置
最近部门考虑搭建一个集成人员权限管理,媒体文件共享,版本可追朔,修改等记录等功能的知识&文件共享平台,最开始考虑用svn,但是文件的每次提交和更新太过繁琐,并且每次更新需要下载到本地才能看,所 ...

gitbook 插件主题

Gitbook 插件主题

文章目录

1. theme-default 插件

1.1 安装

1.2 配置

1.3 效果

2. theme-comscore 插件

2.1 安装

2.2 配置

2.3 效果

3. theme-api 插件

3.1 安装

3.2 配置

3.3 语法

3.4 效果

3.5 布局

gitbook 插件主题相关推荐

最新文章

热门文章

gitbook 插件 主题

Gitbook 插件 主题

文章目录

1. theme-default 插件

1.1 安装

1.2 配置

1.3 效果

2. theme-comscore 插件

2.1 安装

2.2 配置

2.3 效果

3. theme-api 插件

3.1 安装

3.2 配置

3.3 语法

3.4 效果

3.5 布局

gitbook 插件 主题相关推荐

最新文章

热门文章

gitbook 插件主题

Gitbook 插件主题

gitbook 插件主题相关推荐