文章目录
本文概述: 本文向读者朋友介绍了GitBook的
insert-logo
插件的使用,使用该插件可以让文档侧边栏的上侧出现自定义的Logo(可以设置为项目的Logo、团队的Logo、或企业的Logo…),笔者每每看到国内外优秀项目的线上文档时,就好生羡慕,界面友好,文档内容清晰,给人的感觉都很赏心悦目……
原文地址: http://www.crazydeveloper007.com/gitbook-plugins-insert-logo/
PS: 插播点儿题外话,以下是国外开源项目
Kurento
文档截图,该文档是基于Python的Sphinx工具生成(与Node.js的Gitbook是一个意思),总觉得Sphinx
文档工具的一些主题更美观、整洁一些,据了解它是用类似Markdown的另一种标记语言reStructuredText
,未来一定捣鼓捣鼓这个,用它整理的文档实在是太漂亮了!(Python的官方文档就是基于Sphinx的作品)我们的GitBook也想插入一个类似 图1 中文档左上角的那个Logo,怎么实现呢?Follow me, it’s so easy!
1 准备工作
1.1 运行环境之操作系统
本文中使用的操作系统为 CentOS 7.8 64bit
,以下的操作与其他发行版本的 Linux
类似,不再赘述。
1.2 gitbook
的安装与使用
详见文章《基于GitBook搭建“线上”知识管理“平台”》
http://www.crazydeveloper007.com/gitbook-setting-up/
2 安装与配置GitBook的 insert-logo
插件
2.1 修改配置文件 book.json
PS: 默认初始的
gitbook
项目是无此文件的,需要我们手工创建。
- 进入我们的
gitbook
项目目录,笔者是/home/mybook