2017-04-22 18:20:04 +00:00
![Wiki.js ](https://raw.githubusercontent.com/Requarks/wiki-site/1.0/assets/images/logo.png )
2016-08-17 18:39:30 +00:00
2017-02-15 01:48:39 +00:00
[![Release ](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat-square&maxAge=3600 )](https://github.com/Requarks/wiki/releases)
[![License ](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat-square )](https://github.com/requarks/wiki/blob/master/LICENSE)
[![npm ](https://img.shields.io/badge/npm-wiki.js-blue.svg?style=flat-square )](https://www.npmjs.com/package/wiki.js)
2017-03-19 19:32:57 +00:00
[![Downloads ](https://img.shields.io/github/downloads/Requarks/wiki/total.svg?style=flat-square )](https://www.npmjs.com/package/wiki.js)
2017-04-06 01:21:41 +00:00
[![Twitter Follow ](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat-square )](https://twitter.com/requarks)
2017-07-23 20:57:13 +00:00
[![Build Status ](https://app.wercker.com/status/fc8e75793b3cf12852314d6bfd83d148/s/master?style=flat-square )](https://app.wercker.com/project/byKey/fc8e75793b3cf12852314d6bfd83d148)
2017-02-15 01:48:39 +00:00
[![Codacy Badge ](https://img.shields.io/codacy/grade/1d0217a3153c4595bdedb322263e55c8/master.svg?style=flat-square )](https://www.codacy.com/app/Requarks/wiki)
[![Dependency Status ](https://img.shields.io/gemnasium/Requarks/wiki.svg?style=flat-square )](https://gemnasium.com/github.com/Requarks/wiki)
[![Standard - JavaScript Style Guide ](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square )](http://standardjs.com/)
2017-07-09 19:25:30 +00:00
[![Chat on Gitter ](https://img.shields.io/badge/chat-on_gitter-CC2B5E.svg?style=flat-square&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAOCAMAAADUg/YpAAAABlBMVEUAAAD///%2Bl2Z/dAAAAAXRSTlMAQObYZgAAABVJREFUeAFjwAUYYTQByAAh0WicAAAFnwAYeB5bLwAAAABJRU5ErkJggg== )](https://gitter.im/Requarks/wiki)
2016-08-17 01:13:48 +00:00
##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
2017-03-04 16:23:34 +00:00
2017-04-23 22:32:44 +00:00
- [Official Website ](https://wiki.js.org/ )
2017-03-04 16:23:34 +00:00
- [Documentation ](#documentation )
2017-03-19 19:35:06 +00:00
- [Requirements ](#requirements )
- [Change Log ](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md )
2017-04-25 02:43:10 +00:00
- [Feature Requests ](https://wikijs.canny.io/features )
2017-04-21 00:34:13 +00:00
- [Milestones ](#milestones )
- [Chat with us ](#gitter )
2017-05-03 02:24:15 +00:00
- [Translations ](#translations ) *(We need your help!)*
2017-03-04 16:23:34 +00:00
- [Special Thanks ](#special-thanks )
2016-08-17 01:13:48 +00:00
2017-04-21 00:34:13 +00:00
## Documentation
2016-10-17 23:41:14 +00:00
2017-04-23 22:32:44 +00:00
- [Installation Guide ](https://wiki.js.org/get-started.html )
2017-04-19 23:05:28 +00:00
- [Admin Guide ](https://docs.requarks.io/wiki/#admin-guide )
- [User Guide ](https://docs.requarks.io/wiki/#user-guide )
2017-03-04 16:23:34 +00:00
2017-04-21 00:34:13 +00:00
## Requirements
2017-03-04 16:23:34 +00:00
Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.).
2017-07-17 01:32:33 +00:00
- Node.js **6.11.1** or later
2017-03-04 16:27:00 +00:00
- MongoDB **3.2** or later
2017-04-06 01:17:41 +00:00
- Git **2.7.4** or later
2017-03-04 16:23:34 +00:00
- An empty Git repository (optional)
2017-04-23 22:32:44 +00:00
> Read the full [prerequisites](https://docs.requarks.io/wiki/prerequisites) article for full details.
2017-03-04 16:23:34 +00:00
2017-06-10 17:32:53 +00:00
## Cloud Install
2017-06-10 17:34:44 +00:00
[![Deploy to Heroku ](https://www.herokucdn.com/deploy/button.svg )](https://heroku.com/deploy?template=https://github.com/requarks/wiki-heroku)
2017-06-10 17:32:53 +00:00
2017-06-26 21:52:34 +00:00
*Docker, Azure and more coming soon!*
2017-06-10 17:32:53 +00:00
2017-04-21 00:34:13 +00:00
## Milestones
2017-05-16 02:00:01 +00:00
Current and upcoming milestones *(major features only, see the [changelog](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md) for complete list of features and bug fixes)* :
2017-04-21 00:34:13 +00:00
2017-07-22 14:53:28 +00:00
### 1.0.0 - Beta 13
2017-07-09 19:19:26 +00:00
![Progress ](http://progressed.io/bar/100 )
2017-05-16 02:00:01 +00:00
2017-07-02 02:24:56 +00:00
- [x] Color Themes
2017-06-26 21:52:34 +00:00
- [x] Server-side TeX/MathML rendering
2017-07-17 20:04:07 +00:00
- [x] Render line breaks by default (GitHub style)
2017-07-05 00:11:05 +00:00
- [x] New Localization: German
2017-08-06 15:45:48 +00:00
### 1.0.5 - Stable
2017-07-22 14:53:28 +00:00
![Progress ](http://progressed.io/bar/100 )
2017-07-21 21:49:07 +00:00
- [x] Bug fixes release
2017-07-29 04:03:33 +00:00
- [x] New Localization: Dutch
2017-07-21 21:49:07 +00:00
2017-07-22 17:58:19 +00:00
### 2.0.0 - Dev
2017-07-09 19:19:26 +00:00
![Progress ](http://progressed.io/bar/20 )
2017-07-05 00:11:05 +00:00
2017-07-22 17:58:19 +00:00
**Breaking Changes**: MongoDB is being phased out in favor of PostgreSQL + Redis. An upgrade tool will be provided to migrate existing data to the new system.
2017-07-25 02:43:47 +00:00
- [ ] GraphQL API
2017-07-30 04:07:17 +00:00
- [x] Migrate to PostgreSQL + Redis datastore
2017-07-09 03:09:35 +00:00
- [ ] History / Revert to previous version
2017-07-08 20:09:14 +00:00
- [ ] Optional Two-Steps Authentication (2FA)
2017-07-05 00:11:05 +00:00
- [ ] Docker support + Auto compile/publish to Docker Hub
2017-06-26 21:52:34 +00:00
- [ ] Support sub-directory installations (e.g. example.com/wiki)
2017-07-09 19:19:26 +00:00
- [ ] Persist system settings to database instead of file-based
2017-07-25 02:43:47 +00:00
- [ ] User Groups + Better permissions management
2017-07-29 04:01:27 +00:00
- [ ] Make use of all available CPU cores, distributed jobs queue
- [ ] Tags per document / folder
- [ ] Comments / Discussion per document
- [ ] Profile page per user
- [ ] Preview changes directly from the editor, without saving
2017-07-30 04:07:17 +00:00
- [x] Modular authentication providers
2017-08-01 22:04:25 +00:00
- [ ] High Availability support (multiple concurrent instances)
2017-04-29 16:37:00 +00:00
2017-06-02 00:51:56 +00:00
### Future
2017-04-29 16:37:00 +00:00
2017-04-21 00:34:13 +00:00
- [ ] Insert Link modal in Editor
- [ ] Better simultaneous user editing handling
2017-04-21 00:36:34 +00:00
- [ ] Upgrade from web UI
2017-04-21 00:34:13 +00:00
## Gitter
2017-03-15 01:27:44 +00:00
Want to discuss features, ideas or issues? Join our [gitter channel ](https://gitter.im/Requarks/wiki ). We are very active and friendly!
2017-04-21 00:34:13 +00:00
## Twitter
2017-04-06 01:17:41 +00:00
Follow our Twitter feed to learn about upcoming updates and new releases!
2017-04-06 01:21:41 +00:00
[![Twitter Follow ](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat-square )](https://twitter.com/requarks)
2017-04-06 01:17:41 +00:00
2017-05-03 02:22:09 +00:00
## Translations
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 ](https://gitter.im/Requarks/wiki ) and we'll provide you with the necessary tool to add translations, no coding required!
**Languages that are already translated:**
- [x] English
- [x] Chinese - *Thanks to [@choicky](https://github.com/choicky)*
2017-07-25 02:43:47 +00:00
- [x] Dutch - *Thanks to [@weirdwater](https://github.com/weirdwater)*
2017-05-16 02:00:01 +00:00
- [x] French
2017-07-02 02:28:36 +00:00
- [x] German - *Thanks to [@joetjengerdes](https://github.com/joetjengerdes)*
2017-05-16 02:00:01 +00:00
- [x] Korean - *Thanks to [@junwonpk](https://github.com/junwonpk)*
2017-05-27 22:10:50 +00:00
- [x] Portuguese - *Thanks to [@felipeplets](https://github.com/felipeplets)*
2017-05-09 13:11:41 +00:00
- [x] Russian - *Thanks to [@efimlosev](https://github.com/efimlosev)*
2017-05-11 22:53:29 +00:00
- [x] Spanish - *Thanks to [@MatiasArriola](https://github.com/MatiasArriola)*
2017-05-03 02:22:09 +00:00
2017-04-21 00:34:13 +00:00
## Special Thanks
2016-12-19 19:05:05 +00:00
2017-04-23 23:14:25 +00:00
![Browserstack ](https://wiki.js.org/assets/images/logo_browserstack.png )
2016-12-19 19:05:05 +00:00
[Browserstack ](https://www.browserstack.com/ ) for providing access to their great cross-browser testing tools.
2016-12-23 18:31:10 +00:00
2017-04-23 23:14:25 +00:00
![DigitalOcean ](https://wiki.js.org/assets/images/logo_digitalocean.png )
2016-12-23 18:31:10 +00:00
[DigitalOcean ](https://www.digitalocean.com/ ) for providing hosting of the Wiki.js documentation site.