desmondc9 / wiki-v1 Goto Github PK

A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown

• Official Website
• Getting Started
• Documentation
• Requirements
• Demo
• Change Log
• Feature Requests
• Milestones
• Chat with us
• T-Shirts Shop
• Translations (We need your help!)
• Special Thanks
• Contribute

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.

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

• Node.js 6.11.1 or later
• MongoDB 3.2 or later
• Git 2.7.4 or later
• An empty Git repository (optional)

Read the full prerequisites article for full details.

A docker image is available on Docker Hub.
You can also use a Dockerfile (see example) or Docker Compose (see example) to run Wiki.js.

Deploy to Heroku using this pre-built deployment template:

Deploy to IBM Cloud Foundry using this pre-built deployment template (thanks to @seafre):

The legacy Wiki.js documentation site is actually running Wiki.js! Check it out »

We do not provide a demo with write access because of potential security / spam issues. The best way to try it is to install it on your own server / computer. It's easy!

Note: As 2.0 is under development, no new features are being developed in the 1.0 branch.

• Fixed: Upgrade to patched Google auth module (Google+ deprecation)

• Added: Open ID Connection provider (thanks to @sazulo)
• Added: Turkish locale is now available (thanks to @MrSimsek)
• Fixed: Paths in git commits are no longer escaped (thanks to @EricFromCanada)
• Fixed: Fixed potential bug when uploading certain images (thanks to @Gnurdle)

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

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

We are looking for translators to make Wiki.js available in multiple languages. If your language is not listed below and would like to contribute to this project, contact us on our gitter channel and we'll provide you with the necessary tool to add translations, no coding required!

Languages that are already translated:

• English
• Chinese - Thanks to @choicky
• Czech - Thanks to @braniqvranik
• Dutch - Thanks to @weirdwater
• Estonian - Thanks to @vonforum
• French
• German - Thanks to @joetjengerdes, @MyZeD
• Greek - Thanks to @ekchatzi
• Italian - Thanks to @CupCakeArmy
• Japanese - Thanks to @johnnyshields, @JO3QMA
• Korean - Thanks to @junwonpk
• Persian - Thanks to @ashkang
• Portuguese - Thanks to @felipeplets
• Russian - Thanks to @efimlosev
• Slovak - Thanks to @braniqvranik
• Spanish - Thanks to @MatiasArriola
• Swedish - Thanks to @pontus-andersson

Algolia for providing access to their incredible search engine.

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

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

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

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

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

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]