首页 > 其他分享 >gitbook的安装与使用

gitbook的安装与使用

时间:2023-04-18 22:36:41浏览次数:48  
标签:md 插件 GitBook -- gitbook 使用 README 安装

gitbook的安装与使用

一、安装gitbook

1.1、基础条件

查看是否安装了nodejs

# node -v
v10.22.0
# npm -v
6.14.6

1.2、安装gitbook

使用npm安装 gitbook

# sudo npm install -g gitbook-cli

二、使用gitbook

2.1、创建书籍

在指定的目录中,通过gitbook官方模板创建书籍

# cd  /opt/blog
# gitbook init
warn: no summary file in this book 
info: create README.md 
info: create SUMMARY.md 
info: initialization is finished 
  • README.md 是介绍页。
  • SUMMARY.md 是目录页。

2.1.1、一般目录结构

├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1
├    ├── README.md
├    ├── something.md
├── chapter
├    ├── README.md
├    ├── something.md
文件名 描述
book.json 配置数据(可选)
README.md 电子书的前言或简介(必须)
SUMMARY.md 电子书目录 (可选)
GLOSSARY.md 词汇/注释术语列表(可选)

可以自己灵活制定自己的目录结构。

2.1.1、book.json的配置说明

变量 描述
root 包含所有图书文件的根文件夹的路径,除了 book.json
structure 指定自述文件,摘要,词汇表等的路径
title 您的书名,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
description 您的书籍的描述,默认值是从 README 中提取出来的。在 GitBook.com 上,这个字段是预填的。
author 作者名。在GitBook.com上,这个字段是预填的。
isbn 国际标准书号 ISBN
language 本书的语言类型 —— ISO code 。默认值是 en
direction 文本阅读顺序。可以是 rtl (从右向左)或 ltr (从左向右),默认值依赖于 language 的值。
gitbook 应该使用的GitBook版本,并接受类似于 >=3.0.0 的条件。
links 在左侧导航栏添加链接信息
plugins 要加载的插件列表(官网插件列表)
pluginsConfig 插件的配置

2.2、预览书籍

在gitbook书籍目录中执行如下命令,便可在本地通过访问http://localhost:4000 进行书籍预览

# gitbook serve

2.3、同时部署多个gitbook服务

gitbook启动的web 服务默认监听4000端口,而重启监控进程默认监听35729端口。
在不改变端口的前提下,一般只可以启动一个电子书web服务。

启动当前gitbook目录

gitbook serve 

启动/somepath/your_docuemtn_dir/下的gitbook目录

gitbook serve /somepath/your_docuemtn_dir/

启动完成后本地就可以通过 http://localhost:4000 进行访问。

如果需要启动多个web服务的话,需要同时修改web端口和监控进程端口:

gitbook serve --lrport 18081 --port 8081 /otherpath/your_docuemtn_dir/

2.4、生产电子书

--- 生成PDF文件
# gitbook pdf ./ ./mybook.pdf
--- 生成ePub文件
# gitbook epub ./ ./mybook.epub
--- 生成Mobi文件
# gitbook mobi ./ ./mybook.mobi

三、插件

3.1、Gitbook 默认带有 5 个插件:

highlight - 语法高亮插件、search - 搜索插件、sharing - 分享插件、font-settings - 字体设置插件、livereload - 热加载插件

3.2、去除自带插件

可以在插件名称前面加 -

"plugins": [
  "-search"
]

Tips:添加插件后要进行安装 gitbook install

gitbook常用CMD

gitbook init //初始化目录文件
gitbook help //列出gitbook所有的命令  
gitbook --help //输出gitbook-cli的帮助信息
gitbook build //生成静态网页
gitbook serve //生成静态网页并运行服务器
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 //卸载对应的gitbook版本
gitbook build --log=debug //指定log的级别
gitbook builid --debug //输出错误信息
222 22
22 222

标签:md,插件,GitBook,--,gitbook,使用,README,安装
From: https://www.cnblogs.com/eword/p/gitbook202210311.html

相关文章

  • 真实机u盘安装CentOS进入dracut模式解决办法
    真实机u盘安装CentOS进入dracut模式解决办法1.问题描述  昨天在真实机器(Dell笔记本)通过U盘安装 CentOS72003 操作系统时,无法正确引导,而是进入 dracut 模式,特此记录。2.解决方法  在dracut模式下,运行" ls-al/dev|grepsd "dracut#ls-al/dev|grepsd ......
  • 【工具类】Git的初次使用,以及与Gitee的关联
    一、下载与安装可以去Git官网下载,链接......
  • [PLC]三菱Works3 编程CC-Link IEF Basic& 乐创Multiprog_Express编程Ethercat 总线伺
    目录总线伺服使用:WORKS3软件一、添加从站•1.浏览工具—配置文件管理—登录•2.浏览找到后缀为CSPP的配置文件(如MR-JE-C_1_zh-Hans.CSPP)•3.选中要添加的文件—右下角登录直到出现下面的对话框二.新建工程1.打开GX-WORKS3软件,创建一个新的FX5U型PLC工程2.修改P......
  • MASA MAUI Plugin (九)Android相册多选照片(使用Android Jetpack套件库)
    MASAMAUIPlugin(九)Android相册多选照片(使用AndroidJetpack套件库)背景MAUI的出现,赋予了广大Net开发者开发多平台应用的能力,MAUI是Xamarin.Forms演变而来,但是相比Xamarin性能更好,可扩展性更强,结构更简单。但是MAUI对于平台相关的实现并不完整。所以MASA团队开展了一个实验性项......
  • JWT的简单使用—扩展(菜鸡随笔)
    JWT的简单使用—扩展(菜鸡随笔)除了基本的身份认证和授权方案,ASP.NETCore还提供了更高级、更全面的身份认证和授权方案,例如自定义身份认证和授权、多因素身份认证、声明式策略等。在本篇文章中,我们将介绍这些高级身份认证和授权方案的实现。声明式策略声明式策略是一种比较灵活......
  • Ubuntu 18.04 下载安装 llvm (version >= 11)
    添加源你可以在llvm找到适合特定版本的Ubuntu源。cd/etc/aptsudocpsources.listsoures.list.barksudovimsources.list#将下面的llvm源(适用于Ubuntu18.04)粘贴进去debhttp://apt.llvm.org/bionic/llvm-toolchain-bionicmaindeb-srchttp://apt.llvm.org/bionic/......
  • VS2010在使用过程中遇到的问题
    一、解决执行后看不到结果,只是屏幕一闪。第一次使用vs2010的同学可能会遇到在执行文件(执行文件·:按下CTRL+F5)时,只出现屏幕一闪,没有看到结果。那么不用慌,这不代表你没有成功。只是,执行速度快,一闪而过。解决方法,如下步骤:1)右击该项目 2)点击属性3)点击连接器4)点击系统5)在右侧会看到子系......
  • break和continue关键字的使用
    break和continue关键字的使用使用范围循环中使用的作用break:switch-case、循环结构中结束当前循环continue:循环结构中结束当次循环......
  • ftp的配置和使用
    推荐步骤:Ø Centos01安装DNS服务器,域名为自己名字首字母.com,添加解析centos01主机和ftp主机名字Ø Centos02安装ftp服务器,创建ftp根目录为自己名字,配置匿名和身份验证ftp数据保存在同一个目录,匿名用户只能上传不能下载,使用本地用户登录ftp可以上传下载修改删除数据实验步骤:Cent......
  • react+ts+hook封装一个table分页组件(建议收藏,直接使用)
    前言大家好我是歌谣我是一名坚持写博客四年的博主最好的种树是十年前其次是现在,今天继续对antdesigntable的分页封装进行讲解封装准备(多看官网)jsx风格的api<><Table<User>columns={columns}dataSource={data}/>/*使用JSX风格的API*/<Table<User>data......