前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >教你用Gitbook写出优雅排版电子书

教你用Gitbook写出优雅排版电子书

作者头像
HelloMin
发布2022-08-11 14:53:39
1.2K0
发布2022-08-11 14:53:39
举报
文章被收录于专栏:Pair ProgrammingPair Programming

前言:

GitBook是一款开源的电子书制作软件,基于Node.js,让你能够使用GitHub/Git和Markdown构建出美丽的pdf文档和网页。相比于简单的Readme,结构更加清晰,内容更加悦目,不来一起试试吗~

安装Gitbook

1.安装Node.js

Windows请到 http://nodejs.org/download/ 下载并安装Node.js

Mac运行

代码语言:javascript
复制
$ brew install node

2. 安装Gitbook

代码语言:javascript
复制
$ npm install gitbook-cli -g

3. 安装Calibre

如果需要导出PDF请到 http://www.calibre-ebook.com/ 下载并安装Calibre。

需要把`ebook-convert`放到系统路径上

代码语言:javascript
复制
$ ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin

编辑电子书

1. 初始化

运行

代码语言:javascript
复制
$ gitbook init

可以在本地初始化一本电子书的目录结构。

其中必备两个文件:

- README.md:为电子书的简介内容

- SUMMARY.md:用来定义电子书章节结构,如:

2. 实时本地预览

运行

代码语言:javascript
复制
$ gitbook serve

可以通过 http://localhost:4000 进行实时预览

手机端小屏幕的显示效果也很不错哦

还可以进行目录选择呐~

3. 导出网页

运行

代码语言:javascript
复制
$ gitbook build

会在`./_book`目录下面生成网页

4. 导出PDF

运行

代码语言:javascript
复制
$ gitbook pdf

会在生成`book.pdf`文件

利用Github + Travis自动发布电子书

1. 新建github仓库

新建github仓库(e.g. `SparkSQL-Internal`),并把markdown文件push上来

2. 配置.travis.yml

新建文件`.travis.yml`,内容如下:

代码语言:javascript
复制
language: node_js

node_js:
- "8"

# 缓存依赖
cache:
directories:
- $HOME/.npm

before_install:
- export TZ='Asia/Shanghai' # 更改时区

# 依赖安装
install:
- npm install gitbook-cli -g
  # 安装 gitbook 插件
- gitbook install

# 构建脚本
script:
    # 自定义输出目录 gitbook build src dest
- gitbook build . ./build
  # - gitbook build . ./build/$CUSTOM_PATH

# 分支白名单
branches:
only:
- master # 只对 master 分支进行构建

# GitHub Pages 部署
deploy:
provider: pages
skip_cleanup: true
  # 在项目仪表盘的 Settings -> Environment Variables 中配置
github_token: $GITHUB_TOKEN
  # 将 build 目录下的内容推送到默认的 gh-pages 分支上,并不会连带 build 目录一起
local_dir: build
  #fqdn: $CUSTOM_DOMAIN
name: $GIT_NAME
email: $GIT_EMAIL
on:
branch: master

3. 配置travis

在travis网页 https://travis-ci.org/ 上关联github上的项目,然后配置以下三个参数:

1. GIT_EMAIL

2. GIT_NAME = `SparkSQL-Internal`

3. GITHUB_TOKEN

GITHUB_TOKEN需要到github网页 https://github.com/settings/tokens 生成一个token

4. 访问网页

最后可以在:

http://marsishandsome.github.io/SparkSQL-Internal/

访问电子书网页,并且每次修改内容后会自动更新网页。

最后推荐2本我用gitbook写的电子书

一本是关于Spark的:

http://marsishandsome.github.io/SparkSQL-Internal/

另外一本是最近学吉他的资料:

https://marsishandsome.github.io/learning-guitar/

Schönes Wochenende!

我的2019周更计划已完成:32/52

[**********..........]

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2019-08-10,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Pair Programming 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
数据库
云数据库为企业提供了完善的关系型数据库、非关系型数据库、分析型数据库和数据库生态工具。您可以通过产品选择和组合搭建,轻松实现高可靠、高可用性、高性能等数据库需求。云数据库服务也可大幅减少您的运维工作量,更专注于业务发展,让企业一站式享受数据上云及分布式架构的技术红利!
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档