wikijs-fork/README.md

<a href="https://github.com/Requarks/wiki">
    <img src="https://raw.githubusercontent.com/Requarks/wiki/master/assets/favicons/favicon-96x96.png" alt="Wiki.js" title="Wiki.js" align="right" />
</a>

# Wiki.js

[![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)
[![npm Downloads](https://img.shields.io/npm/dt/wiki.js.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js)
[![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)  
[![Build Status](https://img.shields.io/travis/Requarks/wiki/master.svg?style=flat-square)](https://travis-ci.org/Requarks/wiki)
[![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)
[![Known Vulnerabilities](https://snyk.io/test/github/requarks/wiki/badge.svg?style=flat-square)](https://snyk.io/test/github/requarks/wiki)
[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

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

- [Official Website](https://wiki.requarks.io/)
- [Documentation](#documentation)
  - [Requirements](#requirements)
  - [Change Log](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md)
- [Project Planning](https://waffle.io/Requarks/wiki)
- [Special Thanks](#special-thanks)

### Documentation

- [Installation Guide](https://wiki.requarks.io/get-started.html)
- [Admin Guide](https://docs.wiki.requarks.io/#admin-guide)
- [User Guide](https://docs.wiki.requarks.io/#user-guide)

### Requirements

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

- Node.js **4.6.0** or later
- MongoDB **3.2** or later
- Git **2.11.0** or later
- An empty Git repository (optional)

Read the full [prerequisites](https://docs.wiki.requarks.io/prerequisites) article for full details.

### Gitter

Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly!

### Special Thanks

![Browserstack](https://wiki.requarks.io/assets/images/logo_browserstack.png)  
[Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.

![DigitalOcean](https://wiki.requarks.io/assets/images/logo_digitalocean.png)  
[DigitalOcean](https://www.digitalocean.com/) for providing hosting of the Wiki.js documentation site.
Added favicons 2016-08-17 18:39:30 +00:00			`<a href="https://github.com/Requarks/wiki">`
Markdown display fixes + error pages 2016-12-06 02:42:41 +00:00			`<img src="https://raw.githubusercontent.com/Requarks/wiki/master/assets/favicons/favicon-96x96.png" alt="Wiki.js" title="Wiki.js" align="right" />`
Added favicons 2016-08-17 18:39:30 +00:00			`</a>`

Markdown display fixes + error pages 2016-12-06 02:42:41 +00:00			`# Wiki.js`
Updated README.md 2016-08-17 01:13:48 +00:00
npm installation feature 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)`
Update README.md 2017-03-15 01:00:12 +00:00			`[![npm Downloads](https://img.shields.io/npm/dt/wiki.js.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js)`
Update README.md 2017-03-15 01:18:46 +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)`
npm installation feature 2017-02-15 01:48:39 +00:00			`[![Build Status](https://img.shields.io/travis/Requarks/wiki/master.svg?style=flat-square)](https://travis-ci.org/Requarks/wiki)`
			`[![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)`
			`[![Known Vulnerabilities](https://snyk.io/test/github/requarks/wiki/badge.svg?style=flat-square)](https://snyk.io/test/github/requarks/wiki)`
			`[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)`
Updated README.md 2016-08-17 01:13:48 +00:00
			`##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown`
Removed all native comp. depdencies + fixes 2017-03-04 16:23:34 +00:00
			`- [Official Website](https://wiki.requarks.io/)`
			`- [Documentation](#documentation)`
Updated snyk + README 2017-03-04 16:36:00 +00:00			`- [Requirements](#requirements)`
			`- [Change Log](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md)`
Update README.md 2017-03-15 01:27:44 +00:00			`- [Project Planning](https://waffle.io/Requarks/wiki)`
Removed all native comp. depdencies + fixes 2017-03-04 16:23:34 +00:00			`- [Special Thanks](#special-thanks)`
Updated README.md 2016-08-17 01:13:48 +00:00
Removed inch badge 2016-10-17 23:41:14 +00:00			`### Documentation`

Files Management + Editor Modal + Code Editor fixes 2016-12-22 01:38:12 +00:00			`- [Installation Guide](https://wiki.requarks.io/get-started.html)`
Removed all native comp. depdencies + fixes 2017-03-04 16:23:34 +00:00			`- [Admin Guide](https://docs.wiki.requarks.io/#admin-guide)`
			`- [User Guide](https://docs.wiki.requarks.io/#user-guide)`

			`### Requirements`

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

Updated README.md 2017-03-04 16:27:00 +00:00			`- Node.js 4.6.0 or later`
			`- MongoDB 3.2 or later`
Removed all native comp. depdencies + fixes 2017-03-04 16:23:34 +00:00			`- Git 2.11.0 or later`
			`- An empty Git repository (optional)`

			`Read the full [prerequisites](https://docs.wiki.requarks.io/prerequisites) article for full details.`

Update README.md 2017-03-15 01:27:44 +00:00			`### Gitter`

			`Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly!`

Added DigitalOcean sponsor 2016-12-23 18:31:10 +00:00			`### Special Thanks`
Update README.md 2016-12-19 19:05:05 +00:00
User delete feature 2017-02-10 18:13:40 +00:00			`![Browserstack](https://wiki.requarks.io/assets/images/logo_browserstack.png)`
Update README.md 2016-12-19 19:05:05 +00:00			`[Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.`
Added DigitalOcean sponsor 2016-12-23 18:31:10 +00:00
User delete feature 2017-02-10 18:13:40 +00:00			`![DigitalOcean](https://wiki.requarks.io/assets/images/logo_digitalocean.png)`
Added DigitalOcean sponsor 2016-12-23 18:31:10 +00:00			`[DigitalOcean](https://www.digitalocean.com/) for providing hosting of the Wiki.js documentation site.`