用gitbook搭建Wiki

最新推荐文章于 2023-03-18 12:26:42 发布

原创

最新推荐文章于 2023-03-18 12:26:42 发布 · 1.3k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#gitbook #gitlab #wiki

本文档详细介绍了如何使用Gitbook搭建Wiki，包括环境准备、创建Git仓库、配置GitLab CI/CD，以及通过Nginx进行服务器部署，解决gitlab-runner权限问题。

用gitbook搭建Wiki

本文参考这篇博客，同时记录一下安装过程遇到的问题。

环境

1、gitbook(1.安装node，2.安装gitbook)

2、nginx(安装教程)

3、gitlab(用gitlab的.gitlab-ci.yml配置CI/CD，配置教程)

过程

1. 创建 git 仓库

2. 进入仓库并使用`gitbook init`初始化目录。也可以手动初始化，在根目录创建文件 `book.json`,`README.md`,`SUMMARY.md`。

book.json如下，添加了一些常用插件

{
   
   
    "gitbook": "3.x.x",
    "title": "我的Wiki",
    "description": "我的Wiki",
    "author": "我的Wiki",

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

lucifly

关注关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

使用gitee+gitbook搭建个人在线电子书

特立独行的博客

03-16

6039

使用gitee+gitbook搭建个人在线电子书

Wiki系列（一）：Wiki系统选择

juemuren444的博客

05-08

1545

随着工作和项目经验的积累，有很多知识点需要整理，其中有关开发或者技术方面的，我想搭建一个 Wiki 系统，既可以方便自己查询，也给有需要的人参考，工欲善其事必先利其器，所以这篇就来写下 Wiki 系统的选择。待选首先，我结合已知的第三方 Wiki 系统，以及网上搜索的比较火的开源项目，整理出以下的待选列表。语雀看云 Notion GitBook VuePress docsify 筛选接下来从不同方面对上面的待选列表进行逐一筛选。自定义程度第三方 Wiki 系统，如「语雀」和「看云」.

参与评论您还未登录，请先登录后发表或查看评论

github 私有化部署_GitHub - zwzvvv/deploy: 通过 GitBook 开源框架和 GitHub 私有化部署 Wiki 文档...

weixin_31222401的博客

01-14

456

项目介绍思路：通过将 Wiki 文档内容的仓库托管在 GitHub 之上，并且将 GitBook 框架的代码放在仓库中，然后找一台有 Node.js 环境的服务器，通过简单的几行命令就能部署成功，十分钟内能搞定。从而具备多人协作、版本控制、Markdown 写作、代码高亮、实时更新的特性。一、效果展示1、Material Design 中文版(有侧边栏菜单)2、GitBook Help Cent...

gitbookwiki:知识管理的新尝试

03-29

执照版权所有2020 Scott Simontis 特此免费授予获得该软件和相关文档文件（“软件”）副本的任何人无限制地处理软件的权利，包括但不限于使用，复制，修改，合并的权利，发布，分发，再许可和/或出售本软件的副本，并允许配备有本软件的人员这样做，但须满足以下条件：以上版权声明和此许可声明应包含在本软件的所有副本或大部分内容中。本软件按“原样”提供，不提供任何形式的明示或暗示担保，包括但不限于对适销性，特定目的的适用性和非侵权性的担保。无论是由于软件，使用或其他方式产生的，与之有关或与之有关的合同，侵权或其他形式的任何索赔，损害或其他责任，作者或版权所有者概不负责。软件。

windows服务器实用（6）——gitbook安装与部署

redAnt的博客

03-18

3452

本地在线文档的搭建（前篇）

一秒搭建gitbook

weixin_33941350的博客

02-13

298

gitbook docker 镜像为gitbook docker镜像效果图效果如下图所示使用说明环境准备需要docker环境。使用步骤第一种请先frok本项目 frok完成以后，登录主机，输入如下命令，项目拉取下来 git clone [您的frok项目地址]; 进行本地构建，输入如下代码 sudo docker b...

gitbook搭建

Alan的博客

01-04

840

nodejs,gitbook安装及使用最简化版流程

3分钟搭建属于自己的技术文档WIKI

04-04

docsify 是一个动态生成文档网站的工具，可以将.md 文件以 wiki 的形式展示给读者，可以用于制作技术文档、用户手册、wiki 等。可以部署于主机、VPS、Github、静态云存储（例如阿里云 OSS）。官网：...

PeiQi-WIKI-RED:林深时见鹿，海蓝时见鲸:deer:

04-28

这个文库用于整合互联网上关于渗透测试的资料和技巧，与相似，PeiQI WiKi-RED文库同样也是开源面向所有人的，大家可以随时在线翻阅或者下载本地搭建:whale: 公众号和作者 [!NOTE] 更新的文章都会在第一时间推送在...

Gitbook详解（八）-发布书籍

JiangMing-JIM的博客

04-11

3231

文章目录发布书籍发布到Github Pages申请 Github 账号创建一个项目仓库推送静态网站文件到Github仓库中创建 Pages 服务并部署自己的静态网站发布到Gitee Pages申请 Gitee 账号创建一个项目仓库推送静态网站文件到Github仓库中创建 Pages 服务并部署自己的静态网站发布电子书文件发布书籍在我们编写完成书籍后，可以将其编译的相关书籍的电子书文件发布给别人共享，目前主流的方式：将编译的 HTML 网站文件部署到自己的互联网中的 web 服务器中，供大家访问浏览，

GitBook，GitLab实现5分钟搭建企业级Wiki

qq_15898739的博客

06-18

8437

GitBook是一款文档编辑工具，支持多人协作，同时支持Git。希望通过本文，帮忙更多人搭建属于自己的Wiki。

【测试开发】基于gitbook构建自己学习总结的wiki

2025 热爱与开始

03-05

418

基于gitbook构建wiki Date : 2021.02.03 Author: jwensh 关键词： gitbook webhook jenkins nginx wiki 文章目录基于gitbook构建wiki1.构建一个gitlab项目，并用初始化2.在jenkins上添加一个job3.使用nginx来挂在gitbook build后的html文件4.上面算是已经配置完毕5.book.json 备份内容 1.构建一个gitlab项目，并用初始化在本地和服务器上安装cn

gitbook的搭建

u014761412的博客

05-10

615

gitbook的作用 GitBook 是一个基于 Node.js 的命令行工具，支持 Markdown 和 AsciiDoc 两种语法格式，可以输出 HTML、PDF、eBook 等格式的电子书。GitBook 可以理解为文档格式转换工具。所以GitBook并不是编辑工具，MarkDown编辑工具可以使用GitBook Editor（整合了git和markdown编辑器） linux搭建gitb...

[Skill]GitBook搭建

TOMACAT的博客

09-20

1288

Gitbook Linux centos7.2安装方式 1. 安装node.js 从官网拿到文件的下载链接：英文网址：https://nodejs.org/en/download/ 中文网址：http://nodejs.cn/download/ wget https://npm.taobao.org/mirrors/node/v10.16.3/node-v10.16.3-linux-x64....

架设gitbook

baidu_38235521的博客

04-10

949

gitbook GitBook 是一个基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 来制作精美的电子书下面就来简单介绍gitbook的安装和几种插件的使用体验。 1.gitbook安装详细安装教程可以参考博客：http://www.cnblogs.com/Lam7/p/6109872.html 我也是根据该博客步骤来的，很详细了。同时也有参考

Gitbook环境搭建

涛涛baby

06-16

3152

http://nodejs.cn/download/ http://www.cnblogs.com/Lam7/p/6109872.html http://www.runoob.com/nodejs/nodejs-install-setup.html http://blog.youkuaiyun.com/vip_guo/article/details/52400268 http://blog.c

gitbook 搭建自己的技术站

weixin_41815063的博客

01-16

2701

为什么要搭建自己的book呢？做只属于自己的一本技术管理书籍，目录清晰明朗，方便自己查阅，最最重要的就是以防电脑硬件故障，丢失自己最心爱的笔记。。。。快速上手、打开命令窗口，执行下面的一系列操作。。。安装 cnpm install gitbook-cli -g gitbook -V //查看版本号 gitbook init book //...

gitbook搭建在线书籍

BI_Worker的博客

04-10

4000

gitbook搭建在线书籍

如何搭建 GitBook

Iron 的博客

10-22

9415

如何搭建 GitBook 程序员都喜欢使用 Markdown 来撰写文档，无论是开发用的技术文档，还是自己的学习总结文档，都离不开 Markdown ，今天给大家介绍一款高效管理、发布 Markdown 文档的工具 - GitBook 。关于 GitBook 首先来看一下官方的定义： Modern documentation format and toolchain using Git a...

wiki.js和confluence哪个更好用？

最新发布

03-21

<think>好的，我现在需要回答用户关于wiki.js和Confluence哪个更好用的问题。首先，我应该明确这两个工具的基本信息和适用场景，然后根据不同的需求进行比较。首先，wiki.js是一个开源的Wiki平台，使用Node.js开发，支持多种数据库。它可能更适合技术团队或者需要高度定制化的用户，因为开源意味着可以自由修改代码，而且可能成本较低。另外，用户提到它支持Markdown和可视化编辑器，这可能对技术用户和非技术用户都有吸引力。然后是Confluence，这是Atlassian公司的商业产品，通常与Jira等其他工具集成。Confluence可能更适合中大型企业，尤其是那些已经在使用Atlassian生态系统的团队。它的权限管理和企业级功能可能更完善，但需要付费订阅，这可能对预算有限的小团队来说是个考虑因素。接下来，我需要比较它们的几个关键点：安装部署、功能特性、协作体验、扩展性、成本和适用场景。安装部署方面，wiki.js作为开源软件可能需要自己搭建服务器，适合有技术能力的团队。而Confluence作为SaaS可能更方便，但企业也可以选择自托管，不过需要处理许可证问题。功能特性方面，Confluence可能更全面，比如页面模板、任务管理、与Jira的深度集成，这对项目管理很重要。而wiki.js的轻量级可能更适合文档管理，但可能缺乏一些高级协作功能。协作体验方面，Confluence的评论、@提及和版本控制可能更成熟，适合需要频繁协作的团队。而wiki.js虽然也有这些功能，但可能在用户体验上不如Confluence流畅。扩展性方面，wiki.js的开源特性允许更多自定义，而Confluence的插件市场可能提供更多现成的解决方案，但需要付费插件可能会增加成本。成本方面，wiki.js免费，适合预算有限的团队，而Confluence按用户收费，长期使用成本可能较高，但大企业可能更愿意为支持和服务付费。适用场景的话，wiki.js适合中小团队、技术用户或需要定制的场景，而Confluence适合中大型企业、非技术团队或需要深度协作和集成的环境。还需要考虑用户的技术能力，如果团队没有IT支持，Confluence的云服务可能更省心。另外，数据安全和合规性方面，Confluence可能提供更好的保障，特别是企业版。最后，我应该总结这些点，给出选择建议，帮助用户根据自身情况做决定。同时要确保回答结构清晰，分点明确，符合用户的要求。</think>### Wiki.js 与 Confluence 对比分析以下从**功能定位、适用场景、优缺点**等角度逐步分析，帮助您根据需求选择更合适的工具： --- #### 1. **基础定位** - **Wiki.js** - **开源免费**：基于 Node.js 的轻量级 Wiki 系统，支持自托管。 - **灵活性高**：可通过插件扩展功能，适合技术团队定制。 - **核心功能**：文档协作、Markdown 支持、多数据库兼容（如 PostgreSQL、MySQL）。 - **Confluence** - **商业付费**：Atlassian 公司的企业级知识管理工具，需订阅（按用户数收费）。 - **生态整合**：与 Jira、Trello 等 Atlassian 工具深度集成，适合项目管理场景。 - **核心功能**：结构化文档、权限管理、模板库、高级搜索。 --- #### 2. **关键对比维度** | **维度** | **Wiki.js** | **Confluence** | |------------------|----------------------------------------|-----------------------------------------| | **安装部署** | 需自建服务器，适合技术团队 | 提供 SaaS 云服务或企业自托管（需许可证） | | **协作体验** | 轻量化，Markdown 友好 | 富文本编辑更直观，评论/任务管理完善 | | **权限管理** | 基础权限控制 | 精细化权限分层（页面/空间级别） | | **扩展性** | 依赖社区插件，需自主开发 | 官方插件市场丰富（如图表、宏） | | **成本** | 免费（服务器成本自理） | 按用户数订阅（适合预算充足的企业） | --- #### 3. **适用场景建议** - **选择 Wiki.js 的情况**： - 团队有技术能力维护服务器，追求低成本。 - 需求简单，以文档存储和共享为主，无需复杂项目管理。 - 需要开源自由修改代码（例如定制化界面或功能）。 - **选择 Confluence 的情况**： - 企业已有 Atlassian 生态（如 Jira），需无缝协作。 - 需要严格权限管控和审计功能（如金融、医疗行业）。 - 非技术团队为主，依赖“开箱即用”的体验。 --- #### 4. **常见痛点** - **Wiki.js 的不足**： - 插件生态较弱，复杂功能需自行开发。 - 缺乏原生移动端支持。 - 多人协作时版本冲突处理较基础。 - **Confluence 的不足**： - 价格较高（小型团队可能负担重）。 - 界面复杂度高，学习曲线陡峭。 - 数据存储在第三方（云版），部分企业顾虑安全性。 --- #### 5. **替代方案补充** 若两者均不完全匹配需求，可考虑： - **Notion**：适合小型团队，兼顾文档与数据库。 - **GitBook**：开发者友好，Markdown 与 Git 集成。 - **飞书文档**：国内团队协作，集成 IM 与 OA。 --- ### 总结 - **Wiki.js**：优先考虑“技术可控性”和“成本”时选它。 - **Confluence**：优先考虑“企业级功能”和“生态整合”时选它。建议根据团队规模、技术能力、预算及协作需求综合评估。

用gitbook搭建Wiki

用gitbook搭建Wiki

环境

过程

1. 创建 git 仓库

2. 进入仓库并使用gitbook init初始化目录。也可以手动初始化，在根目录创建文件 book.json,README.md,SUMMARY.md。

2. 进入仓库并使用`gitbook init`初始化目录。也可以手动初始化，在根目录创建文件 `book.json`,`README.md`,`SUMMARY.md`。