【git】基于gitbook的文档版本管理
创始人
2025-06-01 19:20:25
0

在我们的学习工作中,常常会遇到文档不好管理,修改不好回溯等问题,基于gitbook的文档版本管理就能解决这一问题,gitbook可以很方便的为我们管理方案或知识文档,类似云笔记。

在这里插入图片描述

文章目录

    • 1. 环境配置
    • 2. 初始化book
    • 3. 本地预览
    • 4. 输出
    • 5. 发布

1. 环境配置

gitbook可在线或离线编辑,在线即在网页端,离线的话需要配置环境。

gitbook地址:https://www.gitbook.com/

安装Nodejs:https://nodejs.org/en

安装完成后,输入node -v查看版本号:

在这里插入图片描述

安装gitbook-cli脚手架:npm install -g gitbook-cli

安装完成后,输入gitbook -V查看版本号。

如果出现错误,可能是node版本的问题:http://www.ushinian.cn/archives/54

gitbook类似我们的云笔记,也是基于Markdown语法编辑的,编辑器的话,大家可以选择Typora、VSCode、SublimeText等,自行下载即可。

2. 初始化book

创建文件夹如:mybook

初始化:gitbook init

初始化完成后,默认会生成:SUMMARY.md、README.md

在这里插入图片描述

README类似于mybook的简介部分,而SUMMARY则相当于mybook的目录。

3. 本地预览

本地目录初始化完成后,先本地生成预览:

每次修改文章目录后,通过执行 gitbook init 自动生成对应的文件
gitbook serve
http://localhost:4000	//浏览器输入

4. 输出

gitbook支持导出如下格式:

HTML格式:本地生成的_book目录
PDF 格式:安装相关包

还可用这条命令打包html到指定目录:gitbook build ./{book_name} --output=./{outputFolde}

要打包pdf需要安装包:npm install gitbook-pdf -g

然后执行命令打包pdf:gitbook pdf .

5. 发布

可以将gitbook通过github pages发布出去,这样所有人都可以看到这个在线书籍/笔记了。

创建github仓库如mybook,并创建gh-pages分支,有了这个分支,会自动创建http://USERNAME.github.io/mybook

然后同步本地仓库到这个分支即可。

以上。

相关内容

热门资讯

linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
C++ 机房预约系统(六):学... 8、 学生模块 8.1 学生子菜单、登录和注销 实现步骤: 在Student.cpp的...
JAVA多线程知识整理 Java多线程基础 线程的创建和启动 继承Thread类来创建并启动 自定义Thread类的子类&#...
【洛谷 P1090】[NOIP... [NOIP2004 提高组] 合并果子 / [USACO06NOV] Fence Repair G ...
国民技术LPUART介绍 低功耗通用异步接收器(LPUART) 简介 低功耗通用异步收发器...
城乡供水一体化平台-助力乡村振... 城乡供水一体化管理系统建设方案 城乡供水一体化管理系统是运用云计算、大数据等信息化手段࿰...
程序的循环结构和random库...   第三个参数就是步长     引入文件时记得指明字符格式,否则读入不了 ...
中国版ChatGPT在哪些方面... 目录 一、中国巨大的市场需求 二、中国企业加速创新 三、中国的人工智能发展 四、企业愿景的推进 五、...
报名开启 | 共赴一场 Flu... 2023 年 1 月 25 日,Flutter Forward 大会在肯尼亚首都内罗毕...
汇编00-MASM 和 Vis... Qt源码解析 索引 汇编逆向--- MASM 和 Visual Studio入门 前提知识ÿ...
【简陋Web应用3】实现人脸比... 文章目录🍉 前情提要🌷 效果演示🥝 实现过程1. u...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
windows安装JDK步骤 一、 下载JDK安装包 下载地址:https://www.oracle.com/jav...
分治法实现合并排序(归并排序)... 🎊【数据结构与算法】专题正在持续更新中,各种数据结构的创建原理与运用✨...
在linux上安装配置node... 目录前言1,关于nodejs2,配置环境变量3,总结 前言...
Linux学习之端口、网络协议... 端口:设备与外界通讯交流的出口 网络协议:   网络协议是指计算机通信网...
Linux内核进程管理并发同步... 并发同步并发 是指在某一时间段内能够处理多个任务的能力,而 并行 是指同一时间能够处理...
opencv学习-HOG LO... 目录1. HOG(Histogram of Oriented Gradients,方向梯度直方图)1...
EEG微状态的功能意义 导读大脑的瞬时全局功能状态反映在其电场结构上。聚类分析方法一致地提取了四种头表面脑电场结构ÿ...
【Unity 手写PBR】Bu... 写在前面 前期积累: GAMES101作业7提高-实现微表面模型你需要了解的知识 【技...