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

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

Go to file

Nicolas Giard e49cb03882 docs: update README		6 years ago
.github	Create FUNDING.yml	6 years ago
.vscode	feat: save page	6 years ago
client	fix: editor media modal - dark	6 years ago
dev	fix: webpack build error	6 years ago
server	feat: db ssl support	6 years ago
.babelrc	misc: upgrade apollo-server + remove temp dep resolutions	6 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: webpack refactor	7 years ago
.gitattributes	Base Project Files	8 years ago
.gitignore	fix: code lint	6 years ago
.npmrc	chore: updated dependencies	7 years ago
.nvmrc	feat: image upload + list root assets (wip)	6 years ago
BACKERS.md	docs: update BACKERS	6 years ago
LICENSE	Initial commit	8 years ago
Makefile	refactor: removed redis + new scheduler engine	6 years ago
README.md	docs: update README	6 years ago
config.sample.yml	fix: sample config file typo (#853 )	6 years ago
package.json	misc: upgrade apollo-server + remove temp dep resolutions	6 years ago
sonar-project.properties	fix: sonarqube project key	6 years ago
wiki.js	fix: npm tasks cleanup	6 years ago
yarn.lock	misc: upgrade apollo-server + remove temp dep resolutions	6 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!

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