wiki README

The project's README from github.com/requarks/wiki. As one markdown file: README.md.

Wiki.js

Release License Standard - JavaScript Style Guide Build + Publish
GitHub Sponsors Open Collective backers and sponsors Downloads Docker Pulls
Chat on Discord Follow on Bluesky Follow on Telegram Reddit

A modern, lightweight and powerful wiki app built on NodeJS

Follow our Twitter feed to learn about upcoming updates and new releases!

Donate

Wiki.js is an open source project that has been made possible due to the generous contributions by community backers. If you are interested in supporting this project, please consider becoming a sponsor, becoming a patron, donating to our OpenCollective, via Paypal or via Ethereum (0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5).

Become a Sponsor Become a Patron Donate on OpenCollective Donate via Paypal
Donate via Ethereum Buy a T-Shirt

Gold Tier Sponsors

GitHub Sponsors

Support this project by becoming a sponsor. Your name will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [Become a sponsor]

Alexander Casassovici
(@alexksso)
Broxen
(@broxen)
Dacon
(@xDacon)
Maxime Pierre
(@DonNabla)
Jay Daley
(@JayDaley)
Oleksii
(@idokka)
Shane Kearney
(@shanekearney)

OpenCollective Sponsors

Support this project by becoming a sponsor. Your logo will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [Become a sponsor]

Patreon Backers

Thank you to all our patrons! 🙏 [Become a patron]

  • Aeternum
  • Al Romano
  • Alex Balabanov
  • Alex Milanov
  • Alex Zen
  • Arti Zirk
  • Ave
  • Brandon Curtis
  • Damien Hottelier
  • Daniel T. Holtzclaw
  • Dave 'Sri' Seah
  • djagoo
  • dz
  • Douglas Lassance
  • Ergoflix
  • Ernie Reid
  • Etienne
  • Flemis Jurgenheimer
  • Florent
  • Günter Pavlas
  • hong
  • Hope
  • Ian
  • Imari Childress
  • Iskander Callos
  • Josh Stewart
  • Justin Dunsworth
  • Keir
  • Loïc CRAMPON
  • Ludgeir Ibanez
  • Lyn Matten
  • Mads Rosendahl
  • Mark Mansur
  • Matt Gedigian
  • Mike Ditton
  • Nate Figz
  • Patryk
  • Paul O'Fallon
  • Philipp Schürch
  • Tracey Duffy
  • Quaxim
  • Richeir
  • Sergio Navarro Fernández
  • Shad Narcher
  • ShadowVoyd
  • SmartNET.works
  • Stepan Sokolovskyi
  • Zach Crawford
  • Zach Maynard
  • 张白驹

OpenCollective Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Special Thanks

Browserstack
Browserstack for providing access to their great cross-browser testing tools.

Cloudflare
Cloudflare for providing their great CDN, SSL and advanced networking services.

DigitalOcean
DigitalOcean for providing hosting of the Wiki.js documentation site and APIs.

Icons8
Icons8 for providing access to their beautiful icon sets.

Lokalise
Lokalise for providing access to their great localization tool.

MacStadium
MacStadium for providing access to their Mac hardware in the cloud.

Netlify
Netlify for providing hosting for our website.

ngrok
ngrok for providing access to their great HTTP tunneling services.

Porkbun
Porkbun for providing domain registration services.

wiki (requarks/wiki)

Searching Database…

29K ·GitHub
这是什么?Wiki.js 是一个基于 Node.js 的开源 wiki 应用——一个自托管的网页应用,用来编写和整理文档以及团队知识。
Wiki.js 是托管服务,还是需要我自己部署运行的?需要你自己运行:它是一个 Node.js 服务器应用,部署在你自己的基础设施上,页面通过浏览器阅读和编辑。
我怎么把它跑起来?按照官方文档网站上的安装指南操作即可;应用需要 Node.js 20 或更高版本,Kubernetes 部署还有现成的 Helm chart。
有什么我需要留意的坑吗——比如许可协议之类的?它采用 AGPL-3.0 许可证,所以如果你修改了 Wiki.js 并把它作为网络服务对外提供,就必须公开你修改后的源代码。Node.js 20+ 的服务器也需要你自己维护。
它只能跑在 Linux 上,还是什么操作系统都行?它是跨平台的——任何能运行 Node.js 20+ 的环境都可以,CI 主要针对 Linux 和 Kubernetes 部署;访问者只需要一个浏览器。
它自带哪些集成功能?依赖项包括 Algolia 搜索、Keycloak 身份认证、Azure Blob Storage、Apollo GraphQL 服务器、ACME/Let's Encrypt 证书工具和 Akismet 垃圾信息防护——也就是说搜索、单点登录、云存储、API、自动 SSL 证书和垃圾信息过滤都是内置的集成点。
安装之前能先试试吗?可以,README 里在文档和安装指南之外还附了官方演示地址。这个项目始于 2016 年,在 GitHub 上有大约 29,000 颗星。
内容本身是怎么存储的——纯文件还是 Markdown?Markdown 和 git 是这个项目的核心主题之一,所以页面用 Markdown 编写,git 集成也是一级特性;具体的存储后端请参考官方文档。
What are similar projects?PandaWiki, docs, outline, gollum, docmost, BookStack, jevbox, directus
Creator
requarks
Size
51.1 MB
Stars
29K
Age
10y
Commits · 90 Days