Wiki.js | A modern and powerful wiki app built on Node.js

hacktoberfest documentation nodejs cross-platform markdown wiki git open-source

Go to file

Nick a8c7710412 feat: load dev locale files		5 years ago
.github	misc: delete main.workflow	5 years ago
.vscode	feat: save page	6 years ago
client	feat: load dev locale files	5 years ago
dev	feat: git init + commands	5 years ago
server	feat: load dev locale files	5 years ago
.babelrc	fix: setup issues + webpack improvements	6 years ago
.editorconfig	fix: root admin access deny bug + patreon link	5 years ago
.eslintignore	refactor: dev optimizations + improvements	6 years ago
.eslintrc.yml	feat: webpack refactor	7 years ago
.gitattributes	Base Project Files	8 years ago
.gitignore	fix: await page render to finish before resolving	5 years ago
.npmrc	chore: updated dependencies	7 years ago
.nvmrc	fix: terser dependency incompatbility	5 years ago
BACKERS.md	docs: update BACKERS.md	5 years ago
CHANGELOG.md	feat: load dev locale files	5 years ago
LICENSE	Initial commit	8 years ago
Makefile	feat: delete page	5 years ago
README.md	fix: await page render to finish before resolving	5 years ago
config.sample.yml	feat: HTTPS support	5 years ago
package.json	feat: storage modes + git improvements	5 years ago
wiki.js	fix: dark mode handling	6 years ago
yarn.lock	feat: storage modes + git improvements	5 years ago

README.md

A modern, lightweight and powerful wiki app built on NodeJS

✅ STABLE v1.x version

This repository is for the 2.0 BETA of Wiki.js.
It is highly recommended to use the 1.x version until a stable version of 2.0 is released. An easy and quick upgrade path will be provided to migrate from 1.x to 2.0.

👉 Go to version 1.x instead 👈

Version 2.0 should NOT be used in production! Once again, please use 1.x for now!

🚧 UNSTABLE v2.0 BETA version

This version is for testing and development purposes only! It is not ready for production and is still missing critical features. You cannot migrate 1.x data at this time!

Official Website (Coming soon, pointing to 1.x for now)
Documentation
Requirements
Demo
Change Log
Feature Requests
Milestones
Chat with us
T-Shirts Shop
Translations (We need your help!)
Special Thanks
Contribute

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 patron or donating to our OpenCollective.

Requirements

Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.) or using Docker!

Node.js 10.12 or later
One of the following supported database engines:
- MySQL 5.7.8 or later
- PostgreSQL 9.5 or later
- MariaDB 10.2.7 or later
- Microsoft SQL Server 2012 or later
- SQLite 3.9 or later
Redis 3.0 or later

Read the full prerequisites article for full details.

Docker

Docker is the recommended way to go! Simply use Docker image: requarks/wiki:beta

You can also use Docker Compose (see example) to run Wiki.js with all dependencies.

Demo

Check out our documentation site, it's running Wiki.js!

Milestones

📑 See project board to keep track of current progress.

Gitter

Want to discuss features, ideas or issues? Join our gitter channel. We are very active and friendly!

Twitter

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

T-Shirts Shop

Want to donate to this project but get something in return as well? Check out our amazing t-shirts for men, women and kids, as well as other goodies: Wiki.js Shop

Translations

We are looking for translators to make Wiki.js UI available in as many languages as possible. If you would like to contribute to this project, contact us on our gitter channel and we'll provide you access to our translation tool, absolutely no coding required!