You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
wiki/README.md

12 KiB

Wiki.js

Release License Backers on Open Collective Downloads Docker Pulls
Build status Quality Gate Status Maintainability Rating Security Rating Standard - JavaScript Style Guide
Chat on Slack Twitter Follow Subscribe to Newsletter

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).

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

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!

Chat on Slack

Twitter

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

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!

Special Thanks

Algolia
Algolia for providing access to their incredible search engine.

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

Bugsnag
Bugsnag for providing error monitoring solutions.

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

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

Netlify
Netlify for providing hosting for landings and blog websites.

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]

Backers

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

Contributors

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