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

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

Go to file

Nicolas Giard 33669e1ab2 misc: github actions CI test		5 years ago
.github	misc: github actions CI test	5 years ago
.vscode	feat: save page	7 years ago
client	feat: update user	5 years ago
dev	misc: admin vuetify 2.0 UI + arabic display improvements	5 years ago
server	feat: update user	5 years ago
.babelrc	misc: migrate to vuetify 2.0 (wip)	5 years ago
.editorconfig	fix: root admin access deny bug + patreon link	6 years ago
.eslintignore	refactor: dev optimizations + improvements	7 years ago
.eslintrc.yml	feat: editor modals translations	6 years ago
.gitattributes	fix: sidebar display	5 years ago
.gitignore	feat: locales availability + IE display mode	6 years ago
.npmrc	chore: updated dependencies	7 years ago
.nvmrc	feat: analytics modules backend + admin panel	6 years ago
BACKERS.md	docs: update BACKERS.md	5 years ago
LICENSE	Initial commit	8 years ago
Makefile	refactor: removed redis + new scheduler engine	6 years ago
README.md	misc: update wikijs logo in README	5 years ago
config.sample.yml	feat: sideloading + locales nav menu	6 years ago
package.json	fix: Switch converted to Object Literal (#940 )	5 years ago
sonar-project.properties	fix: sonarqube project key	6 years ago
yarn.lock	fix: Switch converted to Object Literal (#940 )	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!

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, donating to our OpenCollective, via Paypal or via Ethereum (0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5).

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!

Slack

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

Twitter

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

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 Slack channel and we'll provide you access to our translation tool, absolutely no coding required!