首页 > 其他分享 >gitbook初识

gitbook初识

时间:2023-09-20 09:23:19浏览次数:50  
标签:md 10.24 js gitbook part1 初识 README

前言

需求是内部想部署一个帮助文档功能,参考页面。 第一印象跟chm搞混了, chm是文件形式的帮助文档,可以传输,即使达成了chm编辑和发布最终也是以html或其它web页面的形式展示和维护。
度娘搜索到一个同类项目列表连接地址。如博主介绍同类项目很多, 没有精力全部试一遍,其中gitgook有听过领导提过,就从这里下手。

环境部署

  • win10
  • node.js 10.24.1
  • gitbook3.2.3

安装node.js 10.24.1

参考地址:https://www.jianshu.com/p/0388d8bb49a7
node.js下载页https://nodejs.org/en
注意

  • nodejs版本目前必须是10.24.1。据说是gitbook这个项目不再维护,无法兼容最新版的node.js, 尝试了网上关于最新版的解决办法还是不行
  • 各版本的nodejs对应不同的npm,卸载/重装时记得删除npm文件夹

点击Other Downloads

下载10.24.1, 滑倒接近页面底部,点击Previous Releases


安装完成后查看版本信息要与上面列表列出的一致
nodejs -v
npm -v

安装gitbook参考连接

npm install -g gitbook-cli

Gitbook的使用参考连接

在你想要的位置新建一个文件夹,然后打开命令行,cd到这个文件夹下。
接着执行以下命令
gitbook init

将summary编辑成下面这个样子

# 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)

写完目录后再次执行gitbook init Gitbook会查找SUMMARY.md中描述的目录和文件,如果没有则会创建。
配置gitbook。 添加 book.json文件

{
    "title": "骑士指南",
    "description": "要想成为强者,决不能绕过挡道的荆棘,也不能回避风雨的冲刷",
    "author": "公爵",
    "output.name": "site",
    "language": "zh-hans",
	"plugins": 
	[
		"toggle-chapters",
		"hide-element",
		"tbfed-pagefooter",
		"-lunr","-search","search-pro",
		"insert-logo"
	],
	"pluginsConfig": {
		"hide-element": {
			"elements": [".gitbook-link"]
		},
		"tbfed-pagefooter": {
				"copyright": "Copyright &copy 公爵 2022",
				"modify_label": "该文章修订时间:",
				"modify_format": "YYYY-MM-DD"
		},
		"insert-logo": {
				"url": "https://cos.gjcloak.xyz/2022/04/28/6269f3340b765.png",
				"style": "background: none"
			}
	  }
}

执行命令安装插件
gitbook install
执行命令开启预览,其中serve可以指定端口
gitbook serve
提示本地预览地址http://localhost:4000/

待解决问题:

  • 文档编辑维护
  • 项目部署收费问题

标签:md,10.24,js,gitbook,part1,初识,README
From: https://www.cnblogs.com/heath/p/17715151.html

相关文章

  • 【JavaScript保姆级教程】输出函数和初识变量
    @TOC前言JavaScript是一种强大的脚本语言,广泛应用于网页开发和应用程序编写。本文将全面介绍JavaScript中输出内容的方法,包括使用document.write()函数、调试工具如console.log()和对话框函数如alert(),以及变量的声明和赋值。此外,我们还将探索输入提示框prompt()函数的使用方法。深......
  • 【JavaScript保姆级教程】输出函数和初识变量
    @TOC前言JavaScript是一种强大的脚本语言,广泛应用于网页开发和应用程序编写。本文将全面介绍JavaScript中输出内容的方法,包括使用document.write()函数、调试工具如console.log()和对话框函数如alert(),以及变量的声明和赋值。此外,我们还将探索输入提示框prompt()函数的使用方法。深......
  • 1. 初识数据库
    ###数据库的本质```python"""本质其实就是一款基于网络通信的应用程序那其实每个人都可以开发一款数据库软件因为它仅仅就是一个基于网络通信的应用程序也就意味着数据库软件其实有很多很多 关系型数据库 MySQL、oracle、db2、access、sqlserver 非关系型数据库 redis、mon......
  • 【Linux从零开始】:0.初识Linux
    从上周末开始下了决心打算学习Linux。之前也为学习寻找了很多资料,昨天,网上买的《鸟哥的Linux私房菜》到了,今天遂开始我的Linux征程。正好有博客园这个平台,正好现在也是懒得记什么笔记,那就把学习的历程和知识在此做一个详细的记录,方便自己之后温故知新。因为懒得编辑了,而且Ubun......
  • 01 初识HTML
    HTML:HyperTextMarkupLanguage,超文本标记语言。<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>Title</title></head><body></body></html>......
  • Elasticsearch 命令行初识
    完整教程:https://www.cnblogs.com/shaner/p/5661071.htmlhttps://zhuanlan.zhihu.com/p/449555826http://192.168.1.10:9201/_cat/health?vhttp://192.168.1.10:9201/_cathttp://192.168.1.10:9201/_cat/indices?vES服务器命令行:----服务器命令行删除大索引curl-XDELETEhttp:......
  • 初识大数据
         高速交互和快速处理:在线购物平台要求用户与平台进行高速交互,而平台在处理数据时也要保持快速响应。这意味着平台需要具备高度并发性和处理大量数据的能力。    用户安全和状态一致性:在处理数据的过程中,平台需要确保用户的安全和数据的状态一致性。这包括......
  • vue 初识
    一、前端的发展史1、前端的发展演变#1HTML(5)、CSS(3)、JavaScript(ES5、ES6、ES11):编写一个个的页面->给后端(PHP、Python、Go、Java)->后端嵌入模板语法->后端渲染完数据->返回数据给前端->在浏览器中查看#2Ajax的出现->后台发送异步请求,Render+Ajax混合......
  • MySQL篇:第二章_初识MySQL
    初始MySQLMySQL的背景1、前身属于瑞典的一家公司,MySQLAB2、08年被sun公司收购3、09年sun被oracle收购MySQL的优点1、开源、免费、成本低2、性能高、移植性也好3、体积小,便于安装数据库的好处​ 1、持久化数据到本地​ 2、可以实现结构化查询,方便管理​数据库相关概......
  • 数据库----初识
    《世界诞生的前夜----开发环境配置》在进入数据库开发软件时遇到这样一个错误:  看起来是SQLServer(数据库管理系统)发生了错误,  找到数据库管理系统设置工具,让SQLServer运行起来就行了......