python课件 gitbook_gitbook使用教程
通过NPM安装
安装 GitBook 的最好办法是通过 NPM。在终端提示符下,只需运行以下命令即可安装 GitBook:
$ npm install gitbook-cli -g
gitbook-cli 是 GitBook 的一个命令行工具。它将自动安装所需版本的 GitBook 来构建一本书。
执行下面的命令,查看 GitBook 版本,以验证安装成功。
$ gitbook -V
安装历史版本
gitbook-cli 可以轻松下载并安装其他版本的GitBook来测试您的书籍:
$ gitbook fetch beta
使用 gitbook ls-remote 会列举可以下载的版本。
创建一本书
初始化
GitBook可以设置一个样板书:
$ gitbook init
如果您希望将书籍创建到一个新目录中,可以通过运行 gitbook init ./directory 这样做。
构建
使用下面的命令,会在项目的目录下生成一个 _book 目录,里面的内容为静态站点的资源文件:
$ gitbook build
Debugging
您可以使用选项 --log=debug 和 --debug 来获取更好的错误消息(使用堆栈跟踪)。例如:
$ gitbook build ./ --log=debug --debug
启动服务
使用下列命令会运行一个 web 服务, 通过 http://localhost:4000/ 可以预览书籍
$ gitbook serve
GitBook 命令
这里主要介绍一下 GitBook 的命令行工具 gitbook-cli 的一些命令, 首先说明两点:
gitbook-cli 和 gitbook 是两个软件
gitbook-cli 会将下载的 gitbook 的不同版本放到 ~/.gitbook中, 可以通过设置GITBOOK_DIR环境变量来指定另外的文件夹
列出 gitbook 所有的命令
gitbook help
输出 gitbook-cli 的帮助信息
gitbook --help
生成静态网页
gitbook build
生成静态网页并运行服务器
gitbook serve
生成时指定gitbook的版本, 本地没有会先下载
gitbook build --gitbook=2.0.1
列出本地所有的gitbook版本
gitbook ls
列出远程可用的gitbook版本
gitbook ls-remote
安装对应的gitbook版本
gitbook fetch 标签/版本号
更新到gitbook的最新版本
gitbook update
卸载对应的gitbook版本
gitbook uninstall 2.0.1
指定log的级别
gitbook build --log=debug
输出错误信息
gitbook builid --debug
Gitbook 目录结构
GitBook 项目结构
GitBook使用简单的目录结构。在 SUMMARY (即 SUMMARY.md 文件)中列出的所有 Markdown / Asciidoc 文件将被转换为 HTML。多语言书籍结构略有不同。
一个基本的 GitBook 电子书结构通常如下:
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
| ├── README.md
| └── something.md
└── chapter-2/
├── README.md
└── something.md
GitBook 特殊文件的功能:
文件描述
book.json
配置数据 (optional)
README.md
电子书的前言或简介 (required)
SUMMARY.md
电子书目录 (optional)
GLOSSARY.md
词汇/注释术语列表 (optional)
静态文件和图片
静态文件是在 SUMMARY.md 中未列出的文件。除非被忽略,否则所有静态文件都将复制到输出路径。
忽略文件和文件夹
GitBook将读取 .gitignore,.bookignore 和 .ignore 文件,以获取要过滤的文件和文件夹。这些文件中的格式遵循 .gitignore 的规则:
1 # This isa comment2
3
4
5 # Ignore the file test.md6
7 test.md8
9
10
11 # Ignore everything in the directory "bin"
12
13 bin/*
14 项目与子目录集成
对于软件项目,您可以使用子目录(如 docs/ )来存储项目文档的图书。您可以配置根选项来指示 GitBook 可以找到该图书文件的文件夹:
4 ├── book.json5
6 └── docs/
7
8 ├── README.md9
10 └── SUMMARY.md
在 book.json 中配置以下内容:
1 {2
3 "root": "./docs"
4
5 }
Summary
GitBook 使用 SUMMARY.md 文件来定义本书的章节和子章节的结构。 SUMMARY.md 文件用于生成本书的目录。
SUMMARY.md 的格式是一个链接列表。链接的标题将作为章节的标题,链接的目标是该章节文件的路径。
向父章节添加嵌套列表将创建子章节。
简单示例:
1
2 # Summary3
4
5
6 * [Part I](part1/README.md)7
8 * [Writing is nice](part1/writing.md)9
10 * [GitBook is nice](part1/gitbook.md)11
12 * [Part II](part2/README.md)13
14 * [We love feedback](part2/feedback_please.md)15
16 * [Better tools for authors](part2/better_tools.md)
每章都有一个专用页面(part#/README.md),并分为子章节。
锚点
目录中的章节可以使用锚点指向文件的特定部分。
1 # Summary2
3
4
5 ### Part I6
7
8
9 * [Part I](part1/README.md)10
11 * [Writing is nice](part1/README.md#writing)12
13 * [GitBook is nice](part1/README.md#gitbook)14
15 * [Part II](part2/README.md)16
17 * [We love feedback](part2/README.md#feedback)18
19 * [Better tools for authors](part2/README.md#tools)
部分
目录可以分为以标题或水平线 ---- 分隔的部分:
1
2 # Summary3
4
5
6 ### Part I7
8
9
10 * [Writing is nice](part1/writing.md)11
12 * [GitBook is nice](part1/gitbook.md)13
14
15
16 ### Part II17
18
19
20 * [We love feedback](part2/feedback_please.md)21
22 * [Better tools for authors](part2/better_tools.md)23
24
25
26 ----
27
28
29
30 * [Last part without title](part3/title.md)
Parts 只是章节组,没有专用页面,但根据主题,它将在导航中显示。
页面
Markdown 语法
默认情况下,GitBook 的大多数文件都使用 Markdown 语法。 GitBook 推荐使用这种语法。所使用的语法类似于 GitHub Flavored Markdown syntax 。
页面内容示例:
1
2 # Title of the chapter3
4
5
6 This isa great introduction.7
8
9
10 ## Section 1
11
12
13
14 Markdown will dictates _most_ of your **book's structure**
15
16
17
18 ## Section 2
19
20
21
22 ...
页面前言
页面可以包含一个可选的前言。它可以用于定义页面的描述。前面的事情必须是文件中的第一件事,必须采取在三虚线之间设置的有效YAML的形式。这是一个基本的例子:
1
2 ---
3
4 description: This is a shortdescription of my page5
6 ---
7
8
9
10 # The content of my page11
12 ...
Glossary
允许您指定要显示为注释的术语及其各自的定义。根据这些术语,GitBook 将自动构建索引并突出显示这些术语。
GLOSSARY.md 的格式是 h2 标题的列表,以及描述段落:
## Term
Definition for this term
## Another term
With it's definition, this can contain bold text
and all other kinds of inline markup ...
Gitbook 配置
GitBook 允许您使用灵活的配置自定义您的电子书。
这些选项在 book.json 文件中指定。对于不熟悉 JSON 语法的作者,您可以使用 JSONlint 等工具验证语法。
常规设置
变量描述
root
包含所有图书文件的根文件夹的路径,除了 book.json
structure
指定自述文件,摘要,词汇表等的路径,参考 Structure paragraph.
title
您的书名,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
description
您的书籍的描述,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
author
作者名。在GitBook.com上,这个字段是预填的。
isbn
国际标准书号 ISBN
language
本书的语言类型 —— ISO code 。默认值是 en
direction
文本阅读顺序。可以是 rtl (从右向左)或 ltr (从左向右),默认值依赖于 language 的值。
gitbook
应该使用的GitBook版本。使用 SemVer 规范,并接受类似于 “> = 3.0.0” 的条件。
author
作者姓名,在GitBook.com上,这个字段是预先填写的。
例:
"author" : "victorzhang"
description
电子书的描述,默认值是从 README 中提取出来的。在GitBook.com上,这个字段是预先填写的。
例:
"description" : "Gitbook教程"
direction
文本的方向。可以是 rtl 或 ltr,默认值取决于语言的值。
例:
"direction" : "ltr"
gitbook
应该使用的GitBook版本。使用SemVer规范,接受类似于 >=3.0.0 的条件。
例:
"gitbook" : "3.0.0",
"gitbook" : ">=3.0.0"
language
Gitbook使用的语言, 版本2.6.4中可选的语言如下:
en, ar, bn, cs, de, en, es, fa, fi, fr, he, it, ja, ko, no, pl, pt, ro, ru, sv, uk, vi, zh-hans, zh-tw
例:
"language" : "zh-hans",
links
在左侧导航栏添加链接信息
例:
"links" : {
"sidebar" : {
"Home" : "https://github.com/atlantis1024/gitbook-notes"
}
}
root
包含所有图书文件的根文件夹的路径, book.json 文件除外。
例:
"root" : "./docs",
structure
指定 Readme、Summary、Glossary 和 Languages 对应的文件名。
styles
自定义页面样式, 默认情况下各generator对应的css文件
例:
"styles": {
"website": "styles/website.css",
"ebook": "styles/ebook.css",
"pdf": "styles/pdf.css",
"mobi": "styles/mobi.css",
"epub": "styles/epub.css"
}
例如要使 h1、h2 标签有下边框, 可以在 website.css 中设置
h1 , h2{
border-bottom: 1px solid #EFEAEA;
}
title
电子书的书名,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预先填写的。
例:
"title" : "gitbook-notes",
plugins
插件及其配置在 book.json 中指定。有关详细信息。
自 3.0.0 版本开始,GitBook 可以使用主题。有关详细信息,请参阅 the theming section 。
变量描述
plugins
要加载的插件列表
pluginsConfig
插件的配置
添加插件
"plugins": [
"splitter"
]
添加新插件之后需要运行 gitbook install 来安装新的插件
去除自带插件
Gitbook 默认带有 5 个插件:
highlight
search
sharing
font-settings
livereload
"plugins": [
"-search"
]
structure
除了 root 属性之外,您可以指定 Readme,Summary,Glossary 和 Languages 的名称(而不是使用默认名称,如README.md)。这些文件必须在项目的根目录下(或 root 的根目录,如果你在 book.json 中配置了 root 属性)。不接受的路径,如:dir / MY_README.md。
变量描述
structure.readme
Readme 文件名(默认值是 README.md )
structure.summary
Summary 文件名(默认值是 SUMMARY.md )
structure.glossary
Glossary 文件名(默认值是 GLOSSARY.md )
structure.languages
Languages 文件名(默认值是 LANGS.md )
可以使用 book.json 中的一组选项来定制PDF输出:
VariableDescription
pdf.pageNumbers
将页码添加到每个页面的底部(默认为 true)
pdf.fontSize
基本字体大小(默认是 12)
pdf.fontFamily
基本字体样式(默认是 Arial)
pdf.paperSize
页面尺寸,选项有: 'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter' (默认值是 a4)
pdf.margin.top
上边界(默认值是 56)
pdf.margin.bottom
下边界(默认值是 56)
pdf.margin.right
右边界(默认值是 62)
pdf.margin.left
左边界(默认值是 62)
生成电子书
GitBook 可以生成一个网站,但也可以输出内容作为电子书(ePub,Mobi,PDF)。
1
2 # Generate a PDF file3
4 $ gitbook pdf ./ ./mybook.pdf5
6
7
8 # Generate an ePub file9
10 $ gitbook epub ./ ./mybook.epub11
12
13
14 # Generate a Mobi file15
16 $ gitbook mobi ./ ./mybook.mobi
安装 ebook-convert
ebook-convert 可以用来生成电子书(epub,mobi,pdf)。
参考链接:
https://blog.csdn.net/myemail_sl/article/details/76273474
python课件 gitbook_gitbook使用教程相关推荐
- python商业爬虫教程_廖雪峰老师的Python商业爬虫课程 Python网络爬虫实战教程 体会不一样的Python爬虫课程...
廖雪峰老师的Python商业爬虫课程 Python网络爬虫实战教程 体会不一样的Python爬虫课程 1.JPG (53.51 KB, 下载次数: 1) 2019-8-9 08:15 上传 2.JPG ...
- python教程吾爱破解_2020年最新python入门到精通教程
2020年最新python入门到精通教程 资源共享吧良心论坛,一直用心为每位会员服务,希望大家能学有所成,今天为大家分享一套2020年最新python入门到精通教程,如果你是0基础想学习python这 ...
- 视频教程-Python零基础入门教程-Python
Python零基础入门教程 从2012年从事互联网至今有7年软件编程经验,曾任职国内北京互联网公司,中南林业大学授课Python 现任逻辑教育Python课程负责人,精通Python语言,精通人工智能 ...
- 视频教程-Python数据分析与案例教程:分析人口普查数据-Python
Python数据分析与案例教程:分析人口普查数据 多年互联网从业经验: 有丰富的的企业网站.手游.APP开发经验: 曾担任上海益盟软件技术股份有限公司项目经理及产品经理: 参与项目有益盟私募工厂.睿妙 ...
- 开课吧python课件_开课吧:廖雪峰数据分析全栈工程师第8期【视频+课件】-百度云下载...
当前位置:IT教程网 > 精品教程 > 开课吧:廖雪峰数据分析全栈工程师第8期[视频+课件]-百度云下载 刘贺稳 发表于 2020-11-05 资源详情 下载记录 资源评价 开课吧:廖雪峰 ...
- 超完整 Python基础入门知识教程
本书旨在帮助Python开发人员发现该语言和相关库的突出特性,并编写简单.流畅.易于阅读和易于维护的代码.特别是生成器.属性描述符(ORM的键)和Python表达式的对象在数据库处理过程中的具体应用: ...
- Blender中的Python脚本介绍学习教程
Blender中的Python脚本介绍学习教程 MP4 |视频:h264,1280×720 |音频:AAC,48000 Hz 语言:英语+中英文字幕(根据原英文字幕机译更准确)|大小解压后:1.63 ...
- 分享一个python cookbook的在线教程地址
分享一个python cookbook的在线教程地址: http://python3-cookbook.readthedocs.org/zh_CN/latest/ 翻译者:熊能 转载于:https:/ ...
- scrapy爬虫储存到mysql_详解Python之Scrapy爬虫教程NBA球员数据存放到Mysql数据库
获取要爬取的URL 爬虫前期工作 用Pycharm打开项目开始写爬虫文件 字段文件items # Define here the models for your scraped items # # S ...
最新文章
- linux下eaccelerator,memcache,memcached安装
- 怎么去除CSDN上的广告?
- hadoop 集群:物理机突然间ping不同虚拟机
- java内存回收机制
- Logrotate 对服务器日志按照小时切割并压缩
- 描述一下JVM加载class文件的原理机制
- 4k视频分辨率的码流_8K电视来了!但是8K视频仍很遥远
- 汉游天下公司的一些感悟
- 字符串输出为什么第一个没了_「课堂笔记」Python基础语法:变量和输入输出
- php当前完整url的写法
- 华为Mate8刷低Android版本,华为mate8怎么刷机 华为mate8刷机方法【图文教程】
- 【爬虫剑谱】二卷4章 实战篇-模拟登录铁路12306网站(滑块验证)
- Ormlite数据库
- 一阶广义差分模型_微波射频差分探针去嵌入理论研究
- blendshapes
- FITC修饰药物;CY3荧光标记氟维司群/依西美坦/齐多夫定/丁二酸(琥珀酸)/醋酸卡泊芬净的定制合成
- 使用Angular和API服务器显示相关表中的数据
- 前端使用sockJs进行聊天通讯的功能
- 支付风控学习笔记(转载)
- 细说Windows系统主流激活的原理与弊端!