百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

Gitbook使用方法(gitbook文档)

ztj100 2025-04-02 00:34 18 浏览 0 评论

GitBook介绍

GitBook可以看作个人的一本电子书。它用MarkDown编写,可以自动生成网页或者PDF等,生成网页可以通过插件配置目录和搜索功能等,可以直接部署到个人站点上,非常适合管理个人的知识库。


安装方法

1. 安装nodejs、npm

Linux主机首先安装npm。

sudo apt update
sudo apt install npm

2. 修改npm国内源

sudo npm config set registry https://registry.npm.taobao.org --global
sudo npm config set disturl https://npm.taobao.org/dist --global

3. 安装gitbook

sudo npm install -g gitbook-cli

4. 查看gitbook版本

# 执行这句话后还会继续安装,直到完成。
gitbook --version

使用方法

1. 初始化笔记本

# 在需要创建笔记本的路径下
gitbook init

2. 配置插件

cd到图书文件夹,编辑book.json文件。其中配置中plugins便是插件,如-lunr代表移除lunr插件,其他为增加。pluginsConfig是插件的配置。

{
    "plugins": [
         "-lunr", "-search","-livereload", "search-pro","-sharing",
         "back-to-top-button","chapter-fold","lightbox",
         "page-toc-button","hide-element","code","splitter",
         "sharing-plus"
    ],
    "pluginsConfig":{
         "hide-element": {
             "elements":[".gitbook-link"]
         },
         "sharing": {
            "qq": true,
            "qzone": true,
            "weibo": true,
            "all": [
                "douban",
                "facebook",
                "google",
                "pocket",
        "instapaper",
                "linkedin",
                "twitter",
                "weibo",
                "messenger",
                "qq",
                "qzone",
                "viber",
                "whatsapp"
            ]
        }
    }
}

3. 下载插件

gitbook install

4. 配置笔记Gitee同步

在gitee新建一个项目,然后同步,可参考git使用教程。

5. 另外创建Gitee仓库上传笔记图片

5.1 创建仓库

5.2 生成令牌

进入gitee个人设置,安全设置 --> 私人令牌生成,注意:令牌只显示一次,务必保存好。

6. 配置PicGo同步笔记图片

6.1 下载PicGo

PicGo下载链接

6.2 安装github-plus插件

需要提前安装nodejs,插件设置 --> github-plus --> 安装,可以在软件中PicGo设置 --> 设置代理和镜像地址中设置npm镜像源为
https://registry.npm.taobao.org/
,安装成功后,图传设置 --> githubPlus设置,填写仓库地址和gitee令牌。设置为默认图床并确认。仓库地址是用户名/仓库名,例如我的仓库地址是:percyc/mybook-pic

7. 配置Typora通过PicGo上传图片

文件 --> 偏好设置 --> 图片,设置如下:

8. 编写笔记本目录

编辑笔记本目录下的SUMMARY.md文件,每次新增目录后都要执行以下命令自动创建相关文档文件。

gitbook init

9. 生成网页文件

gitbook build

10. 同步笔记到Gitee

cd到笔记本根目录,执行以下指令:

git add .
git commit -m "更新的内容"
git push

常见错误

错误1

Error: ENOENT: no such file or directory, stat...

解决方法:找到文件并编辑,

vim ~/.gitbook/versions/3.2.3/lib/output/website/copyPluginAssets.js

找到2个地方包含confirm: true,修改为false即可。

相关推荐

如何将数据仓库迁移到阿里云 AnalyticDB for PostgreSQL

阿里云AnalyticDBforPostgreSQL(以下简称ADBPG,即原HybridDBforPostgreSQL)为基于PostgreSQL内核的MPP架构的实时数据仓库服务,可以...

Python数据分析:探索性分析

写在前面如果你忘记了前面的文章,可以看看加深印象:Python数据处理...

CSP-J/S冲奖第21天:插入排序

...

C++基础语法梳理:算法丨十大排序算法(二)

本期是C++基础语法分享的第十六节,今天给大家来梳理一下十大排序算法后五个!归并排序...

C 语言的标准库有哪些

C语言的标准库并不是一个单一的实体,而是由一系列头文件(headerfiles)组成的集合。每个头文件声明了一组相关的函数、宏、类型和常量。程序员通过在代码中使用#include<...

[深度学习] ncnn安装和调用基础教程

1介绍ncnn是腾讯开发的一个为手机端极致优化的高性能神经网络前向计算框架,无第三方依赖,跨平台,但是通常都需要protobuf和opencv。ncnn目前已在腾讯多款应用中使用,如QQ,Qzon...

用rust实现经典的冒泡排序和快速排序

1.假设待排序数组如下letmutarr=[5,3,8,4,2,7,1];...

ncnn+PPYOLOv2首次结合!全网最详细代码解读来了

编辑:好困LRS【新智元导读】今天给大家安利一个宝藏仓库miemiedetection,该仓库集合了PPYOLO、PPYOLOv2、PPYOLOE三个算法pytorch实现三合一,其中的PPYOL...

C++特性使用建议

1.引用参数使用引用替代指针且所有不变的引用参数必须加上const。在C语言中,如果函数需要修改变量的值,参数必须为指针,如...

Qt4/5升级到Qt6吐血经验总结V202308

00:直观总结增加了很多轮子,同时原有模块拆分的也更细致,估计为了方便拓展个管理。把一些过度封装的东西移除了(比如同样的功能有多个函数),保证了只有一个函数执行该功能。把一些Qt5中兼容Qt4的方法废...

到底什么是C++11新特性,请看下文

C++11是一个比较大的更新,引入了很多新特性,以下是对这些特性的详细解释,帮助您快速理解C++11的内容1.自动类型推导(auto和decltype)...

掌握C++11这些特性,代码简洁性、安全性和性能轻松跃升!

C++11(又称C++0x)是C++编程语言的一次重大更新,引入了许多新特性,显著提升了代码简洁性、安全性和性能。以下是主要特性的分类介绍及示例:一、核心语言特性1.自动类型推导(auto)编译器自...

经典算法——凸包算法

凸包算法(ConvexHull)一、概念与问题描述凸包是指在平面上给定一组点,找到包含这些点的最小面积或最小周长的凸多边形。这个多边形没有任何内凹部分,即从一个多边形内的任意一点画一条线到多边形边界...

一起学习c++11——c++11中的新增的容器

c++11新增的容器1:array当时的初衷是希望提供一个在栈上分配的,定长数组,而且可以使用stl中的模板算法。array的用法如下:#include<string>#includ...

C++ 编程中的一些最佳实践

1.遵循代码简洁原则尽量避免冗余代码,通过模块化设计、清晰的命名和良好的结构,让代码更易于阅读和维护...

取消回复欢迎 发表评论: