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

Gitbook使用方法(gitbook文档)

ztj100 2025-04-02 00:34 6 浏览 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即可。

相关推荐

从IDEA开始,迈进GO语言之门(idea got)

前言笔者在学习GO语言编程的时候,GO语言在国内还没有像JAVA/Php/Python那样普及,绕了不少的弯路,要开始入门学习一门编程语言,最好就先从选择一个好的编程语言的开发环境开始,有了这个开发环...

基于SpringBoot+MyBatis的私人影院java网上购票jsp源代码Mysql

本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍基于SpringBoot...

基于springboot的个人服装管理系统java网上商城jsp源代码mysql

本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍基于springboot...

基于springboot的美食网站Java食品销售jsp源代码Mysql

本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍基于springboot...

贸易管理进销存springboot云管货管账分析java jsp源代码mysql

本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目描述贸易管理进销存spring...

SpringBoot+VUE员工信息管理系统Java人员管理jsp源代码Mysql

本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍SpringBoot+V...

目前见过最牛的一个SpringBoot商城项目(附源码)还有人没用过吗

帮粉丝找了一个基于SpringBoot的天猫商城项目,快速部署运行,所用技术:MySQL,Druid,Log4j2,Maven,Echarts,Bootstrap...免费给大家分享出来前台演示...

SpringBoot+Mysql实现的手机商城附带源码演示导入视频

今天为大家带来的是基于SpringBoot+JPA+Thymeleaf框架的手机商城管理系统,商城系统分为前台和后台、前台用的是Bootstrap框架后台用的是SpringBoot+JPA都是现在主...

全网首发!马士兵内部共享—1658页《Java面试突击核心讲》

又是一年一度的“金九银十”秋招大热门,为助力广大程序员朋友“面试造火箭”,小编今天给大家分享的便是这份马士兵内部的面试神技——1658页《Java面试突击核心讲》!...

SpringBoot数据库操作的应用(springboot与数据库交互)

1.JDBC+HikariDataSource...

SpringBoot 整合 Flink 实时同步 MySQL

1、需求在Flink发布SpringBoot打包的jar包能够实时同步MySQL表,做到原表进行新增、修改、删除的时候目标表都能对应同步。...

SpringBoot + Mybatis + Shiro + mysql + redis智能平台源码分享

后端技术栈基于SpringBoot+Mybatis+Shiro+mysql+redis构建的智慧云智能教育平台基于数据驱动视图的理念封装element-ui,即使没有vue的使...

Springboot+Mysql舞蹈课程在线预约系统源码附带视频运行教程

今天发布的是由【猿来入此】的优秀学员独立做的一个基于springboot脚手架的Springboot+Mysql舞蹈课程在线预约系统,系统项目源代码在【猿来入此】获取!https://www.yuan...

SpringBoot+Mysql在线众筹系统源码+讲解视频+开发文档(参考论文

今天发布的是由【猿来入此】的优秀学员独立做的一个基于springboot脚手架的在线众筹管理系统,主要实现了普通用户在线参与众筹基本操作流程的全部功能,系统分普通用户、超级管理员等角色,除基础脚手架外...

Docker一键部署 SpringBoot 应用的方法,贼快贼好用

这两天发现个Gradle插件,支持一键打包、推送Docker镜像。今天我们来讲讲这个插件,希望对大家有所帮助!GradleDockerPlugin简介...

取消回复欢迎 发表评论: