首页 > 其他分享 >使用gitbook快速搭建文档中心

使用gitbook快速搭建文档中心

时间:2023-10-21 17:55:21浏览次数:52  
标签:info md plugin gitbook 文档 https root 搭建

背景

在研发一个系统,主要给公司内部同事用,按理说,简单点的话,搞个使用文档就行了,但产品经理希望是做成一个文档中心,比如,你学习个新技术的时候,比如vue,一般有个在线的帮助文档,他的想法就是这种。

image-20231021154919586

我们就开始了调研,刚开始看了下wordpress(好多云服务器支持用这个来搭建网站),后面发现好复杂,我们只需要一个清爽的帮助文档而已;后面发现文档中心这种,主要分两类,一类是动态的,有数据库,有后台管理界面,可以在后台管理中去发布文档;一种是静态的,基本就是提供写好的markdown,然后部署到服务器上,用特定技术预先渲染成html,再利用nginx之类的指向这些html,一个静态文档中心就有了。

前一阵调研了一个叫gitbook的,属于静态方案,这里简单记录下搭建过程。

gitbook 简介

gitbook的官网是https://www.gitbook.com/,它官网主要是商业版本,就是个在线网站,你可以在里面写文档,体验还可以;

开源版本维护在github,https://github.com/GitbookIO/gitbook,文档也是在github维护:

https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md

目前,开源版本的发布包,最近一个版本是2018年10月,因为团队都去搞商业版本去了,这边就没维护了。

但是,gitbook做出来效果还可以,它也支持很多插件,由于gitbook是node开发的,所以插件就是各种npm包:

插件可以在npm官网查找,gitbook的插件都是有规范的,是gitbook-plugin-开头:

https://www.npmjs.com/search?ranking=popularity&q=gitbook-plugin-

image-20231021160435536

gitbook做出来的网站的效果

示例1

https://handbook.enspiral.com/guides/blogging

image-20231021161050857

该网站的搜索效果是做不出来的,这个是对接了专门的搜索网站

对应的github:https://github.com/enspiral/handbook

示例2

https://tutorial.djangogirls.org/

github:https://github.com/DjangoGirls/tutorial

开源版本可以做到的搜索的效果:

image-20231021161422389

示例3

这边是一个中文站:

https://uprogrammer.cn/html5-cn/overview.html

image-20231021161757153

大体效果就上面那些,如果觉得还可以,就可以看看怎么搭建了。

gitbook的fork版本

gitbook的开源版本没怎么维护了,但是后面社区又有人接着维护,那就是honkit

https://github.com/honkit/honkit

标签:info,md,plugin,gitbook,文档,https,root,搭建
From: https://www.cnblogs.com/grey-wolf/p/17779281.html

相关文章

  • 汽车租赁管理平台的设计与实现-论文文档
    目录第一章绪论11.1选题背景11.2选题意义11.3研究问题及拟达到目的21.4国内外研究现状2第二章系统分析32.1需求分析32.2系统功能需求42.3系统性能需求92.3.1硬件环境92.3.2软件环境9第三章开发工具简介103.1TOMCAT介绍103.2MYECLIPSE介绍103.3JAVA......
  • 基于Spring boot电商平台-计算机毕业设计源码+LW文档
    一.毕业设计的内容本设计是基于Springboot技术结合MySQL数据库,采用Myeclipse开发工具以及Java语言设计的网上商品购物系统。网上商品购物系统分为前台和后台,前台用于用户查看各种商品,检索想要的商品,还可以进行会员注册和商品选购等功能,而且在购物车提交订单后可以把订单数据传递到......
  • 基于spring boot的健身房管理系统-计算机毕业设计源码+LW文档
    1、题  目:基于springboot的健身房管理系统    2、题目来源:生产实践3、意  义:随着时代的发展,人们对健身和健康的也越来越重视,在很多城市中健身房也随处可见,更多的年轻人喜欢在下班和空闲时间去健身房进行健身和锻炼以提高自己的体质和改变自己的形体。通常健身有......
  • 基于Spring Boot的图书馆管理系统-计算机毕业设计源码+LW文档
    摘要随着时代的发展,图书的重要性显示的越来越突出了,尤其是知识大爆炸的这个年代,人们需要掌握的知识也越来越多,只有不断的提高自己才能够更好的立足于社会,但是通常情况下很多图书的价格比较高,这个时候就可以通过图书馆借阅图书来达到图书阅读的目的,为了让图书借阅变的更加的方便我......
  • 互联网下的数字媒体艺术现状及发展-论文文档
    目录摘要1一、绪论2(一)研究背景及意义21.研究背景22.研究意义2(二)国内外研究现状31.国外研究现状32.国内研究现状3(三)研究内容与方法31.研究内容32.研究方法4二、相关理论及概念5(一)数字媒体艺术的定义5(二)数字媒体艺术的构成5三、数字媒体艺术的现状及发展7(一)数字......
  • 6基于SpringBoot + Vue 的超市进销存系统-计算机毕业设计源码+LW文档
    摘 要 超市管理系统是指一种针对超市的信息化管理系统,它通过计算机技术和网络技术,对超市的采购、销售、库存等业务进行管理和控制。随着社会经济的发展和人们生活水平的提高,超市已经成为人们日常生活中必不可少的消费场所,而超市管理系统的出现则极大地提高了超市的经营效率和......
  • hadoop官方文档解读
    Hadoop是一个分布式计算框架,用于存储和处理大规模数据集。首先搞清楚为什么需要使用HadoopHadoop进行数据处理可以充分利用分布式计算和存储的优势,适用于大规模数据的批处理和分布式计算场景。裸机上进行数据处理则更适合小规模数据或需要实时处理的场景。在裸机上进行数据处......
  • 软件研发流程、架构规范、技术标准、需求过程等全文档
    前言:软件项目管理全文档包括以下几个方面:需求分析、项目规划、过程管理、测试和部署。全文档获取:Q+:262086839例图在文末。正文:一、需求分析是软件项目管理的第一步,也是非常关键的一步。在需求分析阶段,项目团队需要与用户进行深入沟通,了解用户的需求和期望,并对其进行详细的分......
  • Win2012 搭建NTP 服务器
    1、regedit1、修改HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W32Time\Config中"AnnounceFlags"值为52、修改HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W32Time\TimeProviders\NtpServer中"Enabled"值为12、servi......
  • 使用Chocolatey包管理器一键搭建windows开发环境
    最近腾讯开放内测的微信小程序火了,而官方支持IDE只有windows版和Mac版的,稍微研究了一下这个IDE发现是node-webkit开发的,理论上应该是跨平台的,但不知为何这个IDE并没有支持Linux环境。喜欢折腾的我当然是要尝试一下的,奈何是使用Ubuntu作为主力开发环境,所以只能重做一个windows系统了......