餐饮网站建设设计,西宁做网站治愈君博i,官渡区住房和城乡建设局网站,做网站临沂GitBook使用教程
最简单的方式就是使用GitBook编辑器#xff0c;没有什么难度#xff0c;后面的教程主要针对命令行的方式
PS#xff1a;GitBook的book页面默认没有download按钮的 需要到设置中打开#xff0c;打开后再次publish生效 同步GitHub 更新失败#xff0c;无法…GitBook使用教程
最简单的方式就是使用GitBook编辑器没有什么难度后面的教程主要针对命令行的方式
PSGitBook的book页面默认没有download按钮的 需要到设置中打开打开后再次publish生效 同步GitHub 更新失败无法转换成pdf/mobi/epub格式 Token
git config --global gitbook.user username
git config --global gitbook.token yourtoken2. 安装 nodejs
首先我们需要做的是安装 Nodejs。大家可以到 Nodejs 的官网进行下载。下载完成后执行双击进行运行安装。安装完成后打开 cmd 命令行输入 node -v 查看安装的 nodejs 的相关版本信息。
也可以在安装目录中找到 node.exe 文件打开输入 node -v 查看安装的 nodejs 的相关版本信息。
3. nodejs 镜像配置
nodejs 安装完成后我们就可以开始安装 gitbook 了。但是在安装之前我们还需要配置一下 nodejs 插件安装的下载镜像地址。因为默认的镜像地址是在国外需要翻墙才可以访问因此我们需要设置国内的镜像地址。国内的我推荐大家使用阿里巴巴的镜像地址 http://registry.npm.taobao.org 。执行下面的命令进行配置。
npm config set registry http://registry.npm.taobao.org
除了上面的方法外我们也可以在用户主目录下编辑 .npmrc 文件添加一行 registryhttp://registry.npm.taobao.org 保存就可以了。用户的主目录一般在 C:\Users\Administrator 具体随你的操作系统系统盘而定。
4. 全局安装 gitbook
现在我们可以开始安装全局的 gitbook 了。执行 npm install gitbook-cli -g 命令进行安装。安装的过程中由于需要下载安装包因此大家需要等待一定的时间具体时长取决于你的网速和硬件配置。
安装完成后我们可以执行 gitbook -v 查看安装的版本信息。
5. gitbook 常用的命令
安装完成了后我们就可以开始编写内容进行电子书发布了。具体的操作大家可以参考《GitBook简明教程》进行学习。我这里给大家推荐3种最常用的命令
gitbook init //初始化目录文件
gitbook help //列出gitbook所有的命令
gitbook --help //输出gitbook-cli的帮助信息
gitbook build //生成静态网页
gitbook serve //生成静态网页并运行服务器
gitbook build --gitbook2.0.1 //生成时指定gitbook的版本, 本地没有会先下载
gitbook ls //列出本地所有的gitbook版本
gitbook ls-remote //列出远程可用的gitbook版本
gitbook fetch 标签/版本号 //安装对应的gitbook版本
gitbook update //更新到gitbook的最新版本
gitbook uninstall 2.0.1 //卸载对应的gitbook版本
gitbook build --logdebug //指定log的级别
gitbook builid --debug //输出错误信息gitbook
C:\Users\AllenIverson\Desktop\gitcoursegitbookUsage: gitbook [options] [command]Commands:ls List versions installed locallycurrent Display currently activated versionls-remote List remote versions available for installfetch [version] Download and install a versionalias [folder] [version] Set an alias named version pointing to folderuninstall [version] Uninstall a versionupdate [tag] Update to the latest version of GitBookhelp List commands for GitBook* run a command with a specific gitbook versionOptions:-h, --help output usage information-v, --gitbook [version] specify GitBook version to use-d, --debug enable verbose error-V, --version Display running versions of gitbook and gitbook-cligitbook serve
C:\Users\AllenIverson\Desktop\gitbook-testgitbook serve
Live reload server started on port: 35729
Press CTRLC to quit ...info: 7 plugins are installed
info: loading plugin livereload... OK
info: loading plugin highlight... OK
info: loading plugin search... OK
info: loading plugin lunr... OK
info: loading plugin sharing... OK
info: loading plugin fontsettings... OK
info: loading plugin theme-default... OK
info: found 3 pages
info: found 0 asset files
info: generation finished with success in 1.9s !Starting server ...
Serving book on http://localhost:4000gitbook ls
C:\Users\AllenIverson\Desktop\gitcoursegitbook ls
GitBook Versions Installed:* 3.2.2Run gitbook update to update to the latest version.gitbook ls-remote
C:\Users\AllenIverson\Desktop\gitcoursegitbook ls-remote
Available GitBook Versions:4.0.0-alpha.5, 4.0.0-alpha.4, 4.0.0-alpha.3, 4.0.0-alpha.2, 4.0.0-alpha.1, 3.2.2, 3.2.1, 3.2.0, 3.2.0-pre.1, 3.2.0-
pre.0, 3.1.1, 3.1.0, 3.0.3, 3.0.2, 3.0.1, 3.0.0, 3.0.0-pre.15, 3.0.0-pre.14, 3.0.0-pre.13, 3.0.0-pre.12, 3.0.0-pre.11, 3
.0.0-pre.10, 3.0.0-pre.9, 3.0.0-pre.8, 3.0.0-pre.7, 3.0.0-pre.6, 3.0.0-pre.5, 3.0.0-pre.4, 3.0.0-pre.3, 3.0.0-pre.2, 3.0
.0-pre.1, 2.6.7, 2.6.6, 2.6.5, 2.6.4, 2.6.3, 2.6.2, 2.6.1, 2.6.0, 2.5.2, 2.5.1, 2.5.0, 2.5.0-beta.7, 2.5.0-beta.6, 2.5.0
-beta.5, 2.5.0-beta.4, 2.5.0-beta.3, 2.5.0-beta.2, 2.5.0-beta.1, 2.4.3, 2.4.2, 2.4.1, 2.4.0, 2.3.3, 2.3.2, 2.3.1, 2.3.0,2.2.0, 2.1.0, 2.0.4, 2.0.3, 2.0.2, 2.0.1, 2.0.0, 2.0.0-beta.5, 2.0.0-beta.4, 2.0.0-beta.3, 2.0.0-beta.2, 2.0.0-beta.1,
2.0.0-alpha.9, 2.0.0-alpha.8, 2.0.0-alpha.7, 2.0.0-alpha.6, 2.0.0-alpha.5, 2.0.0-alpha.4, 2.0.0-alpha.3, 2.0.0-alpha.2,
2.0.0-alpha.1Tags:latest : 3.2.2pre : 4.0.0-alpha.5gitbook -V
C:\Users\AllenIverson\Desktop\gitcoursegitbook -V
CLI version: 2.3.0
GitBook version: 3.2.2gitbook pdf C:\Users\AllenIverson\Desktop\gitcoursegitbook pdf
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin highlight... OK
info: loading plugin search... OK
info: loading plugin lunr... OK
info: loading plugin sharing... OK
info: loading plugin fontsettings... OK
info: loading plugin theme-default... OK
info: found 3 pages
info: found 0 asset filesEbookError: Error during ebook generation: ebook-convert is not recognized as an internal or external command,
operable program or batch file.错误提示ebook-convert不是内部或外部命令原因是GitBook在生成PDF的过程中使用到calibre的转换功能没有安装calibre或安装了calibre没有配置环境变量都会导致转换PDF失败
C:\Users\AllenIverson\Desktop\gitcoursegitbook pdf
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin highlight... OK
info: loading plugin search... OK
info: loading plugin lunr... OK
info: loading plugin sharing... OK
info: loading plugin fontsettings... OK
info: loading plugin theme-default... OK
info: found 3 pages
info: found 2 asset files
info: generation finished with success in 8.6s !
info: 1 file(s) generated安装calibre后转换成功。PS安装calibre后需要重新启动命令行窗口
设置PDF输出格式
book.json
{gitbook: 2.x.x,title: Go语言圣经,description: The Go Programming Language中文版,language: zh,structure: {readme: preface.md},pluginsConfig: {fontSettings: {theme: white,family: msyh,size: 2},plugins: [yahei,katex,-search]},pdf: {pageNumbers: true, fontFamily: Arial,fontSize: 12,paperSize: a4,margin: {right: 62,left: 62,top: 56,bottom: 56}}
}VariableDescriptionpdf.pageNumbers是否添加页码默认是truepdf.fontSize字体大小默认是12pdf.fontFamily字体默认字体是Arial)pdf.paperSizePaper size, options are a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3, b4, b5, b6, legal, letter (default is a4)pdf.margin.topTop margin (default is 56)pdf.margin.bottomBottom margin (default is 56)pdf.margin.rightRight margin (default is 62)pdf.margin.leftLeft margin (default is 62)gitbook mobi
C:\Users\AllenIverson\Desktop\gitcoursegitbook mobi
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin highlight... OK
info: loading plugin search... OK
info: loading plugin lunr... OK
info: loading plugin sharing... OK
info: loading plugin fontsettings... OK
info: loading plugin theme-default... OK
info: found 32 pages
info: found 34 asset files
info: generation finished with success in 26.0s !
info: 1 file(s) generatedgitbook epub
C:\Users\AllenIverson\Desktop\gitcoursegitbook epub
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin highlight... OK
info: loading plugin search... OK
info: loading plugin lunr... OK
info: loading plugin sharing... OK
info: loading plugin fontsettings... OK
info: loading plugin theme-default... OK
info: found 32 pages
info: found 34 asset files
info: generation finished with success in 18.5s !
info: 1 file(s) generated6. calibre
下载地址 ebook-convert
C:\Users\AllenIverson\Desktop\gitcourseebook-convert
用法: ebook-convert.exe input_file output_file [options]转换不同格式的电子书。input_file 表示输入文件output_file 表示输出文件。这两者作为命令行参数必须指定到最前面。输出的电子书格式可由 output_file 的扩展名得到。同时 output_file 也可以是一种以 .EXT 为扩展名的特殊格式。在这种情况下输出文件的名称则使用输入文件的名称。注意文件名不能以连字号作为开头。如果 output_
file 不含扩展名那么它将被视为一个目录并将会在该目录下生成 HTML 格式的“开放式电子书(OEB)”。这些文件会被视为正常文件而被输出插件所识别。在指定输入和输出文件后您可以自定义特定的转换选项。根据输入和输出文件的类型不同可用的转换选项也不同。如需获取针对输入和输出文件的帮助请在命令行中输入 -h。对于转换系统的完整文档请查阅
https://manual.calibre-ebook.com/conversion.html给 ebook-convert.exe 传有空格的参数时请将参数包括在引号中。例如 C:\some path with spaces选项:--version 显示程序版本号并退出-h, --help 显示此帮助信息并退出--list-recipes 列出内建的订阅清单名。您可以通过如下命令创建基于内建订阅清单的电子书 ebook-convert RecipeName.recipe output.epubebook-convert –version
C:\Users\AllenIverson\Desktop\gitcourseebook-convert --version
ebook-convert.exe (calibre 2.81.0)
Created by: Kovid Goyal kovidkovidgoyal.net使用 7. GitBook 编译生成pdf报错
最近在使用 GitBook 生成静态网页和pdf文件时百度谷歌了很久也没有类似的解决方案最近发现是版本问题我把我的相关经验分享给大家
在执行 gitbook build gitbook servegitbook pdf等命令均保持。报错了错误提示内容如下
info: 10 plugins are installed
info: 9 explicitly listed
info: loading plugin baidu... OK
info: loading plugin donate... OK
info: loading plugin sitemap... OK
info: loading plugin highlight... OK
info: loading plugin search... OK
info: loading plugin lunr... OK
info: loading plugin sharing... OK
info: loading plugin fontsettings... OK
info: loading plugin theme-default... OK
info: found 24 pages
info: found 2 asset files
warn: options property is deprecated, use config.get(key) instead
warn: options.generator property is deprecated, use output.name instead
error: error while generating page README.md:TypeError: this.contentPath is not a function当然也有些网友的报错内容如下
warn: options property is deprecated, use config.get(key) instead
warn: page.progress property is deprecated
warn: sections property is deprecated, use page.content instead
TypeError: Path must be a string. Received undefined这种问题的原因是gitbook的版本太低。大家执行 gitbook update 命令进行升级升级到3.2.2版本即可。
也有网友反映报一下的错
Error: Couldnt locate plugins baidu, donate, Run gitbook install to install plugins from registry.
这是提示插件没有安装的错误。大家执行 gitbook install 命令完成安装即可 8.gitbook-convert
把docx、xml、html、odt文档转成GitBook
安装
$ npm install gitbook-convert -g 常用命令 使用
$ gitbook-convert [options] file [export-directory]
19. 常用插件 本节内容转载自Gitbook 的使用和常用插件 Gitbook 本身功能丰富但同时可以使用插件来进行个性化定制。Gitbook 插件 里已经有100多个插件可以在 book.json 文件的 plugins 和 pluginsConfig 字段添加插件及相关配置添加后别忘了进行安装。
// book.json
{title: Webpack 中文指南,description: Webpack 是当下最热门的前端资源模块化管理和打包工具本书大部分内容翻译自 Webpack 官网。,language: zh,plugins: [disqus,github,editlink,prism,-highlight,baidu,splitter,sitemap],pluginsConfig: {disqus: {shortName: webpack-handbook},github: {url: https://github.com/zhaoda/webpack-handbook},editlink: {base: https://github.com/zhaoda/webpack-handbook/blob/master/content,label: 编辑本页},baidu: {token: a9787f0ab45d5e237bab522431d0a7ec},sitemap: {hostname: http://zhaoda.net/}}
}# 安装插件
$ gitbook install ./editlink
内容顶部显示 编辑本页 链接。
ad
在每个页面顶部和底部添加广告或任何自定义内容。
splitter
在左侧目录和右侧内容之间添加一个可以拖拽的栏用来调整两边的宽度。
image-captions
抓取内容中图片的 alt 或 title 属性在图片下面显示标题。
github
在右上角显示 github 仓库的图标链接。
anchors
标题带有 github 样式的锚点。
chart
使用 C3.js 图表。
styles-sass
使用 SASS 替换 CSS。
styles-less
使用 LESS 替换 CSS。
ga
添加 Google 统计代码。
disqus
添加 disqus 评论插件。
sitemap
生成站点地图。
latex-codecogs
使用数学方程式。
mermaid
使用流程图。
book-summary-scroll-position-saver
自动保存左侧目录区域导航条的位置。
sharing
默认的分享插件。
fontsettings
默认的字体、字号、颜色设置插件。
search
默认搜索插件。
tbfed-pagefooter
自定义页脚显示版权和最后修订时间。
prism
基于 Prism 的代码高亮。
atoc
插入 TOC 目录。
ace
插入代码高亮编辑器。
highlight
默认的代码高亮插件通常会使用 prism 来替换。
github-buttons
显示 github 仓库的 star 和 fork 按钮。
sectionx
分离各个段落并提供一个展开收起的按钮。
mcqx
使用选择题。
include-codeblock
通过引用文件插入代码。
fbqx
使用填空题。
spoiler
隐藏答案当鼠标划过时才显示。
anchor-navigation
锚点导航。
youtubex
插入 YouTube 视频。
redirect
页面跳转。
expandable-chapters
收起或展开章节目录中的父节点。
baidu
使用百度统计。
duoshuo
使用多说评论。
jsfiddle
插入 JSFiddle 组件。
jsbin
插入 JSBin 组件。
开发插件
最好先查看别人的插件是怎么做的然后再看官方文档。
10. 更多GitBook教程
GitBook 中文解說 - 2.4gitbook-documentationgitbook-documentation--------------------- 作者futurismme 来源CSDN 原文https://blog.csdn.net/futurismme/article/details/100579624 版权声明本文为作者原创文章转载请附上博文链接 内容解析ByCSDN,CNBLOG博客文章一键转载插件
