gitbook结合github写书及发布到gitbook上

本案例发布的书可以点击这里看效果

程序员一般喜欢用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

六、查看博主更多文章

gitbook结合github写书及发布到gitbook上相关推荐

简单实用 | 用Gitbook做笔记 / 写书过程全记录
用Gitbook写随笔 1. 准备 2. 开始写书 2.1 创建书籍 2.2 撰写书籍 2.2.1 生成目录 2.2.2 写你所想 2.3 构建书籍 2.4 预览书籍 2.5 生成书籍 3 发布书籍 ...
GitBook关联GitHub
想用GitBook的客户端写文档,但是发现不能登录GitBook的帐号,主要目的是想把工作成果保存到网络上避免放在自己电脑上丢失.于是我采用折衷的办法,用GitBook在本机写作,然后把文章保存在Gi ...
Github官方App发布
Github官方App发布官网下载地址: https://github.com/mobile 百度网盘分享: https://pan.baidu.com/s/1RA8byuybDUJV6n4TPze ...
从0到1，一步步开发React的loading组件，并发布到npm上
没有发布过npm包的同学,可能会对NPM对开发有一种蜜汁敬畏,觉得这是一个很高大上的东西.甚至有次面试,面试官问我有没有发过npm包,当时只用过还没写过,我想应该挺难的,就小声说了没有,然后就让我回去 ...
Vue封装预约日期插件和发布到npm上
插件代码 <template><div class="subscribe-time" v-show="setting.display"> ...
再见JCenter，将你的开源库发布到MavenCentral上吧
本文同步发表于我的微信公众号,扫一扫文章底部的二维码或在微信搜索郭霖即可关注,每个工作日都有文章更新. 关于JCenter废弃这件事情,相信许多朋友早就已经知道了.我在几个月前也专门写过一篇文章分 ...
vue+webpack打包发布到线上后微信公众号H5部分打开白屏,刷新又好了
vue+webpack打包发布到线上后微信公众号H5部分打开白屏,刷新又好了 1.问题 2.原因这次可能的原因 3.过渡方案 4.解决方案 4.1 配置nginx服务器 4.2 前端打包保留两个版本 ...
手写一个自己的 cli 并发布到 npm 上
手写一个自己的 cli 并发布到 npm 上简介:大家平时肯定用过 vue-cli 或者 create-react-app,只需要敲简单的命令行,就可以生成一个完整的项目,非常好用.由于本人所在公司 ...
java注解接收上传文件,前台：Input type=file 后台获取文件内容用的是spring注解，当地环境上传图片是好的，发布到服务器上图片读取不到，求大神指点...
当前位置:我的异常网» Java Web开发 » 前台:Input type="file" 后台获取文件内前台:Input type="file" 后台获取文 ...

gitbook结合github写书及发布到gitbook上

一、安装使用`gitbook`

二、文件介绍

三、通过配置文件来配置

四、发布

五、可以直接下载`gitbook editor`编辑器写书效果更爽

六、查看博主更多文章

gitbook结合github写书及发布到gitbook上相关推荐

最新文章

热门文章

gitbook结合github写书及发布到gitbook上

一、安装使用gitbook

二、文件介绍

三、通过配置文件来配置

四、发布

五、可以直接下载gitbook editor编辑器写书效果更爽

六、查看博主更多文章

gitbook结合github写书及发布到gitbook上相关推荐

最新文章

热门文章

一、安装使用`gitbook`

五、可以直接下载`gitbook editor`编辑器写书效果更爽