本案例发布的书可以点击这里看效果
程序员一般喜欢用
markdown
语法写文档,一般我们使用的markdown
工具有
- 1、
window
系统下:mdcharm
- 2、
mac
系统下:MacDown
虽然使用上面的工具来写文档不错,但是对于如果热衷于写博客或者写书的人来说就不方便(太零散,不方便管理),
gitbook
就能解决这个问题(本人使用gitbook
的时候,发现在里面写的东西不拷贝出来格式就全部乱了)
一、安装使用gitbook
-
1、安装
node
-
2、安装
gitbook
npm install gitbook-cli -g
-
3、初始化项目(新建文件)
gitbook init
-
4、启动服务
gitbook serve // 直接访问localhost:4000
二、文件介绍
-
1、使用
gitbook init
后会自动生成两个文件README.md
和SUMMARY.md
README.md
使用过git
的都知道这个文件SUMMARY.md
就是自己要写文章章节目录
-
2、 简单看下我最基本的目录
-
3、在浏览器中运行的结果
三、通过配置文件来配置
-
1、在书籍下面都可以创建一个
book.json
{ "title": "标题", "author": "作者", "description": "简单描素", "language": "zh-hans", "gitbook": "3.2.3", "styles": { "website": "./styles/website.css" }, "structure": { "readme": "README.md" }, "links": { "sidebar": { "我的博客": "https://blog.csdn.net/kuangshp128" } }, "plugins": [ "-sharing", "splitter", "expandable-chapters-small", "anchors", "github", "github-buttons", "donate", "sharing-plus", "anchor-navigation-ex", "favicon" ], "pluginsConfig": { "github": { "url": "https://github.com/kuangshp/" }, "github-buttons": { "buttons": [{ "user": "kuangshp", "repo": "mysql", "type": "star", "size": "small", "count": true }] }, "donate": { "alipay": "./source/images/donate.png", "title": "", "button": "赞赏", "alipayText": " " }, "sharing": { "douban": false, "facebook": false, "google": false, "hatenaBookmark": false, "instapaper": false, "line": false, "linkedin": false, "messenger": false, "pocket": false, "qq": false, "qzone": false, "stumbleupon": false, "twitter": false, "viber": false, "vk": false, "weibo": false, "whatsapp": false, "all": [ "google", "facebook", "weibo", "twitter", "qq", "qzone", "linkedin", "pocket" ] }, "anchor-navigation-ex": { "showLevel": false }, "favicon": { "shortcut": "./source/images/favicon.jpg", "bookmark": "./source/images/favicon.jpg", "appleTouch": "./source/images/apple-touch-icon.jpg", "appleTouchMore": { "120x120": "./source/images/apple-touch-icon.jpg", "180x180": "./source/images/apple-touch-icon.jpg" } } } }
-
2、关于
book.json
字段的介绍- title: 书籍标题
- author:书籍作者
- description: 描述
- language:语言
- gitbook:gitbook的版本
- styles:自定义样式
- structure:
readme
文件的位置 - links:链接跳转
- plugins:插件
- pluginsConfig:插件的配置
-
3、如果配置了插件就要安装使用
gitbook install ./
-
4、更多可以查看传送门
四、发布
- 1、官网
- 2、建议使用老版本
Welcome to the new GitBook! Looking for the previous version? Head to legacy.gitbook.com.
新版本我是登录不了 - 3、创建书籍后与
github
关联今后直接更新github
代码书籍就会更新 - 4、刚刚测试那个已经生成书籍可以访问点击阅读
五、可以直接下载gitbook editor
编辑器写书效果更爽
-
1、
window
下安装似乎有点问题(自己寻求解决方法) -
2、
mac
电脑下brew install homebrew/cask/gitbook-editor