wikijs-fork/README.md
Nicolas Giard b2fe025785
docs: update README
***NO_CI***
2020-06-07 12:54:38 -04:00

15 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

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 Donate via Bitcoin Buy a T-Shirt

Docker

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

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

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]

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]

  • Al Romano
  • Alex Balabanov
  • Alex Zen
  • Arti Zirk
  • Brandon Curtis
  • djagoo
  • Douglas Lassance
  • Ernie Reid
  • Etienne
  • Flemis Jurgenheimer
  • Günter Pavlas
  • Ian
  • Iskander Callos
  • Josh Stewart
  • Loïc CRAMPON
  • Ludgeir Ibanez
  • Matt Gedigian
  • Philipp Schürch
  • Richeir
  • SmartNET.works
  • Stepan Sokolovskyi
  • 张白驹

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

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.

Icons8
Icons8 for providing beautiful icon sets.

Netlify
Netlify for providing hosting for landings and blog websites.

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, click here to gain access to our translation tool, absolutely no coding required! Feel free to contact us on our Slack channel if you have any questions.