【小沐学前端】GitBook制作在线电子书、技术文档(gitbook + Markdown + node)

本文主要是介绍【小沐学前端】GitBook制作在线电子书、技术文档(gitbook + Markdown + node),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 1、简介
    • 1.1 工具简介
    • 1.2 使用费用
  • 2、安装
    • 2.1 安装node
    • 2.2 安装gitbook
  • 3、测试
    • 3.1 编辑文档
    • 3.2 编译工程
    • 3.3 预览工程
  • 结语

1、简介

官网地址:

https://www.gitbook.com/

在这里插入图片描述
在这里插入图片描述

1.1 工具简介

  • 什么是 GitBook?
    GitBook 是一个现代文档平台,团队可以在其中记录从产品到内部知识库和 API 的所有内容。通过创建一个简单而强大的平台供团队分享知识,从而帮助团队更高效地工作。制作一个用户友好的协作产品,让每个人都可以通过文档创建、编辑和共享知识。

在这里插入图片描述

1.2 使用费用

在这里插入图片描述

2、安装

在这里插入图片描述

2.1 安装node

Node.js 是一个开源的、跨平台的 JavaScript 运行时环境。

  • 官网地址:
https://nodejs.org/zh-cn
https://nodejs.cn/

在这里插入图片描述

  • 安装后如下:
    在这里插入图片描述

  • 通过如下命令测试node是否安装成功。

node -v
npm -v

Node.js 是一个开源和跨平台的 JavaScript 运行时环境。 它是几乎任何类型项目的流行工具!

Node.js 在浏览器之外运行 V8 JavaScript 引擎(Google Chrome 的内核)。 这使得 Node.js 非常高效。

Node.js 应用在单个进程中运行,无需为每个请求创建新线程。 Node.js 在其标准库中提供了一组异步 I/O 原语,以防止 JavaScript 代码阻塞,并且通常,Node.js 中的库是使用非阻塞范例编写的,这使得阻塞行为成为异常而不是常态。

当 Node.js 执行 I/O 操作时,如从网络读取、访问数据库或文件系统,Node.js 不会阻塞线程和浪费 CPU 周期等待,而是会在响应返回时恢复操作。

这使得 Node.js 可以使用单个服务器处理数千个并发连接,而不会引入管理线程并发的负担(这可能是错误的重要来源)。

  • Node.js 最常见的 Hello World 示例是一个 Web 服务器:
const http = require('http');const hostname = '127.0.0.1';
const port = 3000;const server = http.createServer((req, res) => {res.statusCode = 200;res.setHeader('Content-Type', 'text/plain');res.end('Hello World\n');
});server.listen(port, hostname, () => {console.log(`Server running at http://${hostname}:${port}/`);
});

要运行此代码段,请将其保存为 server.js 文件并在终端中运行 node server.js。
在这里插入图片描述
首先先装nvm,为什么装这个?就是node.js各类版本的管理器,随时能切换版本。
如果遇到这种情况,只需要改下版本就可以解决了,不需要处理依赖或重装node.js等问题。

# linux系统安装
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash# windows 安装包
https://github.com/coreybutler/nvm-windows/releases/download/1.1.7/nvm-setup.zip

2.2 安装gitbook

  • 安装gitbook-cli,然后初始化gitbook。
# 切换node版本
nvm install v12.22.3
nvm use v12.22.3# 配置国内加速镜像
npm config set registry https://registry.npm.taobao.org
npm install -g gitbook-cli# 初始化gitbook 
gitbook init

在这里插入图片描述

gitbook --version

在这里插入图片描述

3、测试

3.1 编辑文档

  • 本地生成文件如下:
    在这里插入图片描述
  • 修改文件SUMMARY.md:
# Summary* [Introduction](README.md)
* [前言](readme.md)
* [第一章](part1/README.md)* [第一节](part1/1.md)* [第二节](part1/2.md)* [第三节](part1/3.md)* [第四节](part1/4.md)
* [第二章](part2/README.md)
* [第三章](part3/README.md)
* [第四章](part4/README.md)

在这里插入图片描述

3.2 编译工程

  • 编译文档
gitbook build

在这里插入图片描述

3.3 预览工程

  • 预览文档
gitbook serve

在这里插入图片描述

  • 浏览器查看文档服务器如下:

在这里插入图片描述

在这里插入图片描述

结语

如果您觉得该方法或代码有一点点用处,可以给作者点个赞,或打赏杯咖啡;╮( ̄▽ ̄)╭
如果您感觉方法或代码不咋地//(ㄒoㄒ)//,就在评论处留言,作者继续改进;o_O???
如果您需要相关功能的代码定制化开发,可以留言私信作者;(✿◡‿◡)
感谢各位大佬童鞋们的支持!( ´ ▽´ )ノ ( ´ ▽´)っ!!!

这篇关于【小沐学前端】GitBook制作在线电子书、技术文档(gitbook + Markdown + node)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/658005

相关文章

CSS @media print 使用详解

《CSS@mediaprint使用详解》:本文主要介绍了CSS中的打印媒体查询@mediaprint包括基本语法、常见使用场景和代码示例,如隐藏非必要元素、调整字体和颜色、处理链接的URL显示、分页控制、调整边距和背景等,还提供了测试方法和关键注意事项,并分享了进阶技巧,详细内容请阅读本文,希望能对你有所帮助...

Java实现将Markdown转换为纯文本

《Java实现将Markdown转换为纯文本》这篇文章主要为大家详细介绍了两种在Java中实现Markdown转纯文本的主流方法,文中的示例代码讲解详细,大家可以根据需求选择适合的方案... 目录方法一:使用正则表达式(轻量级方案)方法二:使用 Flexmark-Java 库(专业方案)1. 添加依赖(Ma

Nginx实现前端灰度发布

《Nginx实现前端灰度发布》灰度发布是一种重要的策略,它允许我们在不影响所有用户的情况下,逐步推出新功能或更新,通过灰度发布,我们可以测试新版本的稳定性和性能,下面就来介绍一下前端灰度发布的使用,感... 目录前言一、基于权重的流量分配二、基于 Cookie 的分流三、基于请求头的分流四、基于请求参数的分

基于Canvas的Html5多时区动态时钟实战代码

《基于Canvas的Html5多时区动态时钟实战代码》:本文主要介绍了如何使用Canvas在HTML5上实现一个多时区动态时钟的web展示,通过Canvas的API,可以绘制出6个不同城市的时钟,并且这些时钟可以动态转动,每个时钟上都会标注出对应的24小时制时间,详细内容请阅读本文,希望能对你有所帮助...

HTML5 data-*自定义数据属性的示例代码

《HTML5data-*自定义数据属性的示例代码》HTML5的自定义数据属性(data-*)提供了一种标准化的方法在HTML元素上存储额外信息,可以通过JavaScript访问、修改和在CSS中使用... 目录引言基本概念使用自定义数据属性1. 在 html 中定义2. 通过 JavaScript 访问3.

CSS模拟 html 的 title 属性(鼠标悬浮显示提示文字效果)

《CSS模拟html的title属性(鼠标悬浮显示提示文字效果)》:本文主要介绍了如何使用CSS模拟HTML的title属性,通过鼠标悬浮显示提示文字效果,通过设置`.tipBox`和`.tipBox.tipContent`的样式,实现了提示内容的隐藏和显示,详细内容请阅读本文,希望能对你有所帮助... 效

Python批量调整Word文档中的字体、段落间距及格式

《Python批量调整Word文档中的字体、段落间距及格式》这篇文章主要为大家详细介绍了如何使用Python的docx库来批量处理Word文档,包括设置首行缩进、字体、字号、行间距、段落对齐方式等,需... 目录关键代码一级标题设置  正文设置完整代码运行结果最近关于批处理格式的问题我查了很多资料,但是都没

前端bug调试的方法技巧及常见错误

《前端bug调试的方法技巧及常见错误》:本文主要介绍编程中常见的报错和Bug,以及调试的重要性,调试的基本流程是通过缩小范围来定位问题,并给出了推测法、删除代码法、console调试和debugg... 目录调试基本流程调试方法排查bug的两大技巧如何看控制台报错前端常见错误取值调用报错资源引入错误解析错误

Vue中动态权限到按钮的完整实现方案详解

《Vue中动态权限到按钮的完整实现方案详解》这篇文章主要为大家详细介绍了Vue如何在现有方案的基础上加入对路由的增、删、改、查权限控制,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、数据库设计扩展1.1 修改路由表(routes)1.2 修改角色与路由权限表(role_routes)二、后端接口设计

Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)

《Vue项目的甘特图组件之dhtmlx-gantt使用教程和实现效果展示(推荐)》文章介绍了如何使用dhtmlx-gantt组件来实现公司的甘特图需求,并提供了一个简单的Vue组件示例,文章还分享了一... 目录一、首先 npm 安装插件二、创建一个vue组件三、业务页面内 引用自定义组件:四、dhtmlx