初级web书籍推荐 10分钟轻松搞定Web


初级web书籍推荐 10分钟轻松搞定Web(1)


相信很多童鞋在日常开发中都会有「说明文档」、「学习笔记」和「个人博客」的需求,那么最经济简洁的方式莫过于 GitBook 方案了,10 分钟学习,永久使用

本文将简单介绍 GitBook 的使用方式以及最佳插件搭配方案,快来运行一个与众不同而且免费托管的个人站点吧!

一、安装与使用


初级web书籍推荐 10分钟轻松搞定Web(2)


1.安装 GitBook 插件

npm install gitbook-cli -g

2.查看安装版本

gitbook -V

控制台会输出如下信息:

# Jartto CLI version: 2.3.2 GitBook version: 3.2.3

3.初始化

# 建立项目: mkdir jartto-gitbook-demo # 进入目录: cd jartto-gitbook-demo # 初始化项目 gitbook init


此时,jartto-gitbook-demo 目录下会自动生成如下文件:

. ├── README.md └── SUMMARY.md 0 directories, 2 files


4.启动

gitbook serve


5.访问站点:http://localhost:4000

初级web书籍推荐 10分钟轻松搞定Web(3)

恭喜你,到这一步我们已经完成了基本版本。


初级web书籍推荐 10分钟轻松搞定Web(4)


更详细的操作,请查看如下文档:

  • 官网地址
  • Github 地址
  • 帮助文档
二、重点说明

1.目录结构

当我们运行 gitbook serve 后,jartto-gitbook-demo 目录下会生成一个 _book 文件夹:


初级web书籍推荐 10分钟轻松搞定Web(5)

2.关于 README.md

# Introduction


说明文档,大家应该都不陌生,就不赘述了。

3.关于 SUMMARY.md

# Summary * [Introduction](README.md)

SUMMARY.md 其实就是书的章节目录,我们不妨稍作修改:


初级web书籍推荐 10分钟轻松搞定Web(6)

效果如下:

初级web书籍推荐 10分钟轻松搞定Web(7)

三、补充文档

当然,GitBook 的远比我们想象的强大,我们还可以通过 gitbook help 来查看:


初级web书籍推荐 10分钟轻松搞定Web(8)

四、有趣插件


初级web书籍推荐 10分钟轻松搞定Web(9)


了解上面的操作,使用 GitBook 已经没有任何障碍了。

如果你还想做一些个性化的操作,不妨继续深入。

要安装插架,需要我们有配置文件 book.json,我们可以在根目录下创建:


touch book.json


写入基本配置:


初级web书籍推荐 10分钟轻松搞定Web(10)

插件安装通用命令:

npm install gitbook-plugin-flexible-alerts


例如:我们要安装 flexible-alerts 信息框插件:

npm install gitbook-plugin-flexible-alerts


效果如下:

初级web书籍推荐 10分钟轻松搞定Web(11)

还有很多可用插件,具体如下:

  1. 信息框(flexible-alerts)
  2. 阅读统计(pageview-count)
  3. 侧边栏宽度可调节(splitter)
  4. 页脚版权(page-copyright)
  5. 打赏功能(donate)
  6. 分享当前页面(sharing-plus)
  7. 修改标题栏图标(custom-favicon)
  8. 复选框(todo)
  9. 显示图片名称(image-captions)
  10. 目录折叠(toggle-chapters)
  11. 分章节展示(multipart)
  12. 插入 Logo(insert-logo)
  13. Google 分析(ga)
  14. 返回顶部(back-to-top-button)
  15. 代码添加行号和复制按钮(code)
  16. 高级搜索,支持中文(search-pro)
  17. 添加 Github 图标(github)…

需要注意的是:GitBook 默认带有 5 个插件:

  • highlight
  • search
  • sharing
  • fontsettings
  • livereload

如果要去除自带的插件,可以在插件名称前面加 -,例如:


初级web书籍推荐 10分钟轻松搞定Web(12)

小技巧:NPM 中搜索关键字 GitBook-Plugin,发现更多插件。

五、效果展示

1.GitBook 扩展:

初级web书籍推荐 10分钟轻松搞定Web(13)

2.示例一:

初级web书籍推荐 10分钟轻松搞定Web(14)


3.示例二:

初级web书籍推荐 10分钟轻松搞定Web(15)


4.示例三:

初级web书籍推荐 10分钟轻松搞定Web(16)


六、总结


初级web书籍推荐 10分钟轻松搞定Web(17)


上文介绍了 GitBook 的基本使用和一些实用插件,构建在线文档变得轻而易举。加上 Github 免费的托管平台,我们就可以干更多有趣的事情了。

快输出你的 HTML、PDF、eBook 技术文档吧~


七、热门原创文章推荐

人工智能时代,Web 前端能做什么(二)?

系统负载看不懂?

程序员如何减少开发中的 Bug?


初级web书籍推荐 10分钟轻松搞定Web(18)

掌握开发「在线文档」的技能,丰满你的 Web 前端技术栈。

,

免责声明:本文仅代表文章作者的个人观点,与本站无关。其原创性、真实性以及文中陈述文字和内容未经本站证实,对本文以及其中全部或者部分内容文字的真实性、完整性和原创性本站不作任何保证或承诺,请读者仅作参考,并自行核实相关内容。文章投诉邮箱:anhduc.ph@yahoo.com

    分享
    投诉
    首页