gitbook 入门教程之主题插件
主题插件
目前 gitbook
提供三类文档: Book
文档,API
文档和 FAQ
文档.
其中,默认的也是最常使用的就是 Book
文档,如果想要了解其他两种文档模式,需要引入相应的主题插件.
Book 文档
theme-default 主题
theme-default
是 3.0.0
引入的默认主题,大多数插件针对的都是默认主题,如果切换到其他主题或者自定义主题,可能会造成某些情况下不兼容,甚至报错.
默认情况下,左侧菜单不显示层级属性,如果将 showLevel
属性设置为 true
可以显示层级数字.
示例:
"pluginsConfig": { "theme-default": { "showLevel": true } }
效果:
默认情况下左侧菜单树不显示目录层级
开启层级显示设置后,左侧菜单树显示当前目录层级
theme-comscore 主题
default
默认主题是黑白的,而 comscore
主题是彩色的,即标题和正文颜色有所区分.
示例:
"plugins": [ "theme-comscore" ]
效果:
默认情况下各级标题颜色均是黑色,不同级别的标题仅仅是大小区别.
设置
comscore
主题后,各级标题颜色不同,不仅仅是大小不同.
API 文档
theme-api 插件
如果文档本身是普普通文档模式,切换成 api
文档模式后并不会有太大变化,除非一开始就是接口文档,那样使用 theme-api
插件才能看出效果.
示例:
{ "plugins": ["theme-api"], "pluginsConfig": { "theme-api": { "theme": "dark" } } }
语法:
- 方法区
{% method %} 方法区: 接口说明 {% endmethod %}
- 语法区
{% sample lang="特定语言" %} {% common %}
示例:
{% method -%} ## Simple method {% sample lang="js" -%} This text will only appear for JavaScript. {% sample lang="go" -%} This text will only appear for Go. {% common -%} This will appear for both JavaScript and Go. {% endmethod %}
效果:
添加
api
相关方法后的文档效果,正常会两列显示并在右上角增加语言切换工具.
FAQ 文档
theme-faq 插件
theme-faq
可以帮助我们构建问答中心,预设好常见问题以及相应答案模式,同时为了方便搜索到问题或答案,一般需要搜索插件的配合.
示例:
{ "plugins": [ "theme-faq", "-fontsettings", "-sharing", "-search", "search-plus" ] }
帮助中心没有工具栏,因此涉及到工具类的插件一律失效或主动移除,同时默认搜索插件也会失效.
语法:
- 增加文章间的关联
--- related: - some/other/page.md - another_related_article.md --- Content of my article!
在当前页面底部显示延伸阅读,支持
yaml
语法关联到其他页面.
- 增加头部
logo
{% extends template.self %} {% block faq_header_brand %} <img src="https://mywebsite.com/logo.png" height="30" /> {% endblock %}
新建
_layouts/website/page.html
文件,用于扩展当前主题插件来增加自定义logo
.
- 增加导航栏链接
{% extends template.self %} {% block faq_menu %} <ul class="nav navbar-nav navbar-right"> <li><a href="#">Contact us</a></li> <li><a href="#">Return to SuperWebsite</a></li> </ul> {% endblock %}
新建
_layouts/website/page.html
文件,用于扩展当前主题插件来增加自定义导航栏链接.
示例:
{% extends template.self %} {% block faq_header_brand %} <img src="https://upload.jianshu.io/users/upload_avatars/16648241/57aebe62-b5b5-491a-a9fd-f994d5be7dda.jpg?imageMogr2/auto-orient/strip|imageView2/1/w/240/h/240" /> {% endblock %} {% extends template.self %} {% block faq_menu %} <ul class="nav navbar-nav navbar-right"> <li><a href="https://snowdreams1006.github.io/other/me.html">联系我</a></li> <li><a href="https://snowdreams1006.github.io/">返回主页</a></li> </ul> {% endblock %}
新建
_layouts/website/page.html
文件,增加自定义logo
和导航栏链接.
效果:
小结
本节主要讲解了常用的三种文档模式,其中 default
主题插件,适合一般的博客类网站或静态网站,api
主题插件适合接口文档的编写,faq
主题插件则适合帮助中心.
三种主题插件分别对应不同的应用场景,默认情况下使用的是 default
主题插件,平时介绍的大多数功能插件也大多适合这种主题,另外两种主题可能就不能很好兼容第三方插件,需要亲身体验.

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
且听我一个故事讲透一个锁原理之synchronized
微信公众号:IT一刻钟。 大型现实非严肃主义现场, 一刻钟与你分享优质技术架构与见闻,做一个有剧情的程序员。 关注可第一时间了解更多精彩内容,定期有福利相送哟。 故事从这里展开 蜀国有一个皇帝叫蜀道难,他比较难伺候,别的皇帝早朝都是在大殿上同时接见所有大臣,共商国是。 他不一样,他说早朝你们不要有事没事都跑过来叽叽喳喳,有事则来,无事则该干啥干啥去,然后安排太监每天早上在大门口守着,每次只允许一个大臣进来汇报情况。 “你敢多放进来一个就砍脑袋的干活。“ 太监赶紧下跪,说“谪!“。 第一天,太监传话钦天监求见,皇帝允了,钦天监上殿报曰:”臣禀报,昨日我司夜观星象,西方忽现王星忽明忽暗,恐戎狄那边有乱。“ “朕知道了,退下吧”。一日无事。 第二天,太监传话钦天监求见,皇帝允了。一日无事。 第三天,太监传话钦天监求见......一日无事。 第四天,钦天监......一日无事。 第五天,皇帝不耐烦了,和贾太监说,钦天监这老家伙整天是不是闲着没事,以后他来了不用给我禀报,直接放他上殿讲,讲完让他走吧。 国泰民安的日子依旧过着,每天只有钦天监一个人来报告,贾太监每次看到是钦天监来了,也懒得搭理了,...
- 下一篇
我在 ICU 病房的惊魂一夜
最近 github 上一个 996.icu 的项目炒得很火,有关 996 的话题也持续热度不减。本文我不想谈 996,但觉得有必要说说我在 ICU 病房的真实经历。很早就想写下来,但大部分时间我都花在代码上了,我有许多编程和算法论文的研究任务,优先级很高;和一些杂七杂八的琐事,如近几天忙着在 Linux 操作系统的台式机上倒腾 WiFi 接收器,修复 Reflow 框架的一个小但极其复杂的偶现 bug,以及解决 SDK 升级后用 Scala 语言写的 Android 项目的编译问题,这才刚刚告一段落暂时空闲下来。 2018年11月09日上午,神经外科专家陈谦学教授飞太和医院开会,他是科室主任的导师,顺便做我这台手术。他做过上万台手术,其中显微手术超过五千台,获得过王忠诚神经外科医师奖,全国仅有3人获得过该荣誉。我很幸运。 手术持续了5个多小时,我醒来时,已经在重症监护室(ICU 病房)了。我听到护士(X)说:“你流了很多血,要给你输血。”我听到管床医生大声问我叫什么名字,我回答“zhōu wěi”。过了不知道多久,一个男护士(A)又问我叫什么名字,我回答后,我听见这位护士用急促的声音大...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- Eclipse初始化配置,告别卡顿、闪退、编译时间过长
- Jdk安装(Linux,MacOS,Windows),包含三大操作系统的最全安装
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- MySQL8.0.19开启GTID主从同步CentOS8
- CentOS7,CentOS8安装Elasticsearch6.8.6
- 2048小游戏-低调大师作品
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- Windows10,CentOS7,CentOS8安装Nodejs环境
- CentOS7安装Docker,走上虚拟化容器引擎之路
- SpringBoot2全家桶,快速入门学习开发网站教程