Giter Club home page Giter Club logo

wiki's Introduction

Wiki.js

Release License Backers on Open Collective Sponsors on Open Collective Downloads Docker Pulls
Build status Codacy Badge Standard - JavaScript Style Guide Chat on Gitter Twitter Follow

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!

Requirements

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

  • Node.js 10.12 or later
  • One of the following supported database engines:
    • MySQL 5.7.8 or later
    • PostgreSQL 9.5 or later
    • MariaDB 10.2.7 or later
    • Microsoft SQL Server 2012 or later
    • SQLite 3.9 or later
  • Redis 3.2 or later

Read the full prerequisites article for full details.

Docker

Docker is the recommended way to go! Simply use Docker image: requarks/wiki:beta (coming soon!)

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!

Milestones

๐Ÿ“‘ See project board to keep track of current progress.

Gitter

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

Twitter

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

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

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

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

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

wiki's People

Contributors

ngpixel avatar bamieh avatar johnnyshields avatar nicolasg-rocketleap avatar lub avatar bennycode avatar ericfromcanada avatar kimdaesap avatar xtntx avatar rpdeshaies avatar gitter-badger avatar vnakamura avatar asood123 avatar fa93hws avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.