不论是做一款产品还是管理一个团队,都会需要建立一个wiki系统,来方便内外部的人员快速检索和查看相关的知识。
今天我们分享一个开源项目,它自称为”最强“的开源wiki系统,可以帮助个人和团队快速搭建一个 Wiki 站点,它就是:wiki.js
wiki.js是什么
Wiki.js 是基于 Node.js 构建的现代而强大的 wiki 应用,旨在提供用户友好的界面和功能,以便个人用户或团队轻松创建和管理自己的知识库和文档。它支持跨平台运行,提供一套强大的功能和工具来帮助用户组织和共享信息。
在wiki这个领域竞争是非常激烈的,耳熟能详的产品比如 Confluence、语雀、Notion 等等。Wiki.js 为了让用户可以快速上手,为用户提供全面的解决方案,包括认证、存储、评论系统、多语言支持、访问统计以及全文搜索等等。
安装部署
Wiki.js 几乎可以在任何支持 Node.js 的系统上运行。它可以在Linux、macOS、Windows以及Docker/Kubernetes和Heroku等容器解决方案上运行。安装前我们来看一下资源需求:
硬件需求:
运行Wiki.js的硬件需求资源也不高:
- CPU:2核
- 内存:Linux最低1GB RAM,Windows 和 macOS 系统需要更多的 RAM,本身程序运行大概用掉70MB 的 RAM。
- 存储:至少1GB的专用存储空间
- 网络:这个是当然的,需要可以访问的网络连接。
数据库:
搭配一个简单的 RDBMS 数据库,为了获得最佳性能、功能和未来兼容性,强烈建议使用PostgreSQL。也可以试用MySQLSQL Server等。
Nodejs:
如果想通过源码来运行,需要Nodejs 12以上的偶数版本,注意是偶数,奇数版本不支持。
因为wiki.js支持的安装方式比较多,这里我们选择最简单的docker方式
Docker部署
使用Docker Compose 安装,内容参考如下:
version: "3"
services:
db:
image: postgres:15-alpine
environment:
POSTGRES_DB: wiki
POSTGRES_PASSWORD: wikijsrocks
POSTGRES_USER: wikijs
logging:
driver: "none"
restart: unless-stopped
volumes:
- db-data:/var/lib/postgresql/data
wiki:
image: ghcr.io/requarks/wiki:2
depends_on:
- db
environment:
DB_TYPE: postgres
DB_HOST: db
DB_PORT: 5432
DB_USER: wikijs
DB_PASS: wikijsrocks
DB_NAME: wiki
restart: unless-stopped
ports:
- "80:3000"
volumes:
db-data:
之后执行启动命令:
docker compose up -d
官方也发布有docker镜像,你也可以直接拉取,来启动:
docker run -d -p 8080:3000 --name wiki --restart unless-stopped -e "DB_TYPE=postgres" -e "DB_HOST=db" -e "DB_PORT=5432" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2
使用wiki.js
启动完成后,可以在 http://localhost 访问wiki.js了。
初始化
首先需要初始化一下系统,设置默认的管理员账户即可开始使用。
完成初始化后,就可以用刚刚的管理员账号登录后台了。
接下来我们可以创建页面或者进入管理员界面。
Wiki.js 自带一套相对精美的 UI 设计,并且采用左侧为导航侧栏、右侧则为目录的经典布局,符合一般的从左到右阅读习惯。这也是默认的访客页面。
管理配置
Wiki.js 还自带了一套管理后台,点击「administration」图标即可进入到管理后台界面:
在管理后台中左侧会对有许多 Wiki.js 设置,比如我们可以设置网站的基本信息方便 SEO、管理标签和页面(文章)等。当然,Wiki.js 也提供了多种语言包支持,我们下载右侧的语言包并进行修改即可:
编辑内容
Wiki.js 内置了多种的编辑器供你选择,如 Markdown、Visual Editor(即 WYSIWYG,所见即所得)、AsciiDoc、原始的 HTML 编辑器等。
其中 Markdown 和 Visual Editor 编辑器所支持的功能最为丰富齐全。
在编辑器页面底部状态栏会显示当前文章所处的位置以及字符数,完成编辑之后则需要点击右上角的「保存」按钮才能完成修改;对于文章额外的一些设置,如文章相关的标题、描述又或者发布时间则可以点击旁边的「页面」按钮来进行设置。
自带模块
wiki.js自带很多实用的模块,可以帮助快速上手,比如分析工具,这里面还不止一种,提供了多种分析工具,可以自行选择。
评论
Wiki.js 自带了评论组件,并且还支持其他第三方评论组件的集成使用。
搜索配置:
Wiki当中的知识沉淀会远大于一般的博客,尤其是当知识积累到一定程度时我们就需要通过搜索引擎来帮助我们加快内容检索的效率,从而实现知识复用的最大化。Wiki.js 提供了多种全文搜索引擎方案的支持。
快速体验
其实想要体验wiki.js的使用侧功能,那么可以直接访问wikijs的文档,这个文档就是使用wiki.js来实现的。
使用场景
1.团队知识管理:Wiki.js适用于团队内部知识管理和文档共享,帮助团队成员快速查找和共享信息。
2.项目文档:用于创建和维护项目文档,包括需求文档、设计文档、用户手册等,方便团队协作和追踪项目进展。
3.技术文档库:作为技术团队的知识库,记录技术文档、教程和最佳实践,方便员工之间的技术交流和学习。
4.组织内部协作:用于组织内部各部门之间的协作和信息共享,提高团队之间的沟通和协作效率。
5.团队培训资料:作为培训资料的存储和管理平台,用于制作课程大纲、教材和培训资料,方便员工学习和培训。
6.产品文档中心:用于管理产品文档、说明书和FAQ,帮助客户和用户更好地了解产品和解决问题。
7.个人笔记管理:个人用户可以将Wiki.js作为个人知识库和笔记管理工具,记录想法、笔记和学习资料,便于随时查阅和整理。
总结
总体来说wiki.js提供了一个能力比较完备的快速构建wiki方案,当然在它的能力和特性背后,也有这着不够完善的部分。单纯对比能力wiki.js当然还不如Confluence,但如果你想寻求一个开源免费,并且上手容易的方式,wiki.js是可以考虑尝试的。
项目信息
- 项目名称: wiki.js
- GitHub 链接:https://github.com/requarks/wiki
- Star 数:23K
本文暂时没有评论,来添加一个吧(●'◡'●)