简介
gitbook-plugin-theme-mic
是一款在 Gitbook 中使用的插件,它可以在 Gitbook 中提供类似微信读书 or 知乎日报的主题,提升文档的阅读体验。它基于 vuepress-theme-macarons 进行开发,使用了一些 Vue.js 的技术,因此在使用之前,需要先了解 Vue.js 的基础知识。
安装
在 Gitbook 中使用该主题,需要先安装 gitbook-plugin-theme-mic
。可以使用 npm 进行安装:
$ npm install gitbook-plugin-theme-mic --save
使用
安装完成之后,在 Gitbook 的 book.json
中添加配置:
{ "plugins": [ "theme-mic" ] }
之后,可以使用 gitbook serve
命令进行预览。
配置
gitbook-plugin-theme-mic
也提供了一些配置选项,可以在 book.json
文件中进行设置。
首页
通过设置 themeConfig.home
可以设置首页的数据和布局:
-- -------------------- ---- ------- - -------------- - ------- - -------- ------- --------- -------------- ------------ ------------ ------------ ------------- ------- ------------- ------------------- - - -
侧边栏
侧边栏可以通过 themeConfig.sidebar
进行设置:
{ "themeConfig": { "sidebar": { "/chapter-one/": ["", "guide", "install"], "/chapter-two/": ["", "abc", "123"] } } }
导航栏
导航栏可以通过 themeConfig.nav
进行设置:
-- -------------------- ---- ------- - -------------- - ------ - - ------- ------- ------- --------------------- -- - ------- --------- ------- ----------------------------- - - - -
示例
以下是一个简单的示例,通过配置 book.json
文件,实现了一个含有侧边栏、导航栏和主页的 Gitbook 站点。该站点含有两个章节,每个章节又各包含两个主题。
book.json
-- -------------------- ---- ------- - -------- -------- --------- ---------- - ----------- -- -------------- - ------- - -------- ------- --------- -------------- ------------ ------------ ------------ ------------- ------- ------------- ------------------- -- ---------- - ---- ---- --------------- ---------------- ---------------- ---- ------------- -------------- ---------------- ---- --------------- -------------- -- ------ - - ------- ------- ------- --------------------- -- - ------- --------- ------- ----------------------------- - - - -
index.md
-- -------------------- ---- ------- - ------ -------- ------ ------------------------ -------- -- -- --------- - -------------------- - -------------------- -- ---- - ---------- ----
chapter-one/guide.md
-- -------------------- ---- ------- - --- -- -- ----- -- ---- - ------------------- - -------------------
chapter-one/theme-one.md
# 主题一 这是主题一
chapter-one/theme-two.md
# 主题二 这是主题二
chapter-two/abc.md
-- -------------------- ---- ------- - --- -- -- ----- -- ---- - --------------------- - --------------------
chapter-two/theme-three.md
# 主题三 这是主题三
chapter-two/theme-four.md
# 主题四 这是主题四
通过以上配置和文件,可以生成一个 Gitbook 站点,具体效果可以看截图:
结束语
gitbook-plugin-theme-mic
是一个非常好用的插件,可以让 Gitbook 显得更加漂亮。通过阅读本教程和学习示例,相信您已经能够熟练使用该插件,开发出一份满足需求的 Gitbook 了。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/63458