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?maxAge=3600)](https://github.com/Requarks/wiki/releases)
[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg)](https://github.com/requarks/wiki/blob/master/LICENSE)
[![Github All Releases](https://img.shields.io/github/downloads/Requarks/wiki/total.svg)](https://github.com/Requarks/wiki/releases/latest)
[![Build Status](https://travis-ci.org/Requarks/wiki.svg?branch=master)](https://travis-ci.org/Requarks/wiki)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1d0217a3153c4595bdedb322263e55c8)](https://www.codacy.com/app/Requarks/wiki)
[![Dependency Status](https://gemnasium.com/badges/github.com/Requarks/wiki.svg)](https://gemnasium.com/github.com/Requarks/wiki)
[![Known Vulnerabilities](https://snyk.io/test/github/requarks/wiki/badge.svg)](https://snyk.io/test/github/requarks/wiki)

##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
*Under active development*

### Documentation

- [Official Website](https://wiki.requarks.io/)
- [Installation Guide](https://wiki.requarks.io/get-started.html)

##### Milestones
- [x] Account Management
	- [x] Profile
	- [x] Manage users
	- [x] Create local account
- [x] Assets Management
	- [x] Images
	- [x] Files/Documents
- [x] Authentication
	- [x] Strategies
		- [x] Local
		- [x] Microsoft Account
		- [x] Google ID
		- [x] Facebook
	- [x] Access Rights
		- [x] View
		- [x] Edit / Create
- [x] Background Agent (git sync, cache purge, etc.)
- [x] Caching
- [x] Create Entry
- [x] Documentation
	- [x] Prerequisites
	- [x] Install
	- [x] Authentication
	- [x] Git
	- [x] Upgrade
- [x] Edit Entry
- [x] Git Management
- [x] Markdown Editor
	- [x] Basic Formatting
	- [ ] Insert Link modal
	- [x] Image Selection modal
	- [x] File Selection modal
	- [x] Video player
	- [x] Inline Code
	- [x] Code Editor modal
	- [ ] Table Visual Editor
- [x] Move Entry
- [x] Navigation
- [x] Parsing / Tree / Metadata
- [x] Search
- [x] UI
- [x] View Entry Source

### 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
Update README.md 2017-01-28 04:39:29 +00:00			`[![Release](https://img.shields.io/github/release/Requarks/wiki.svg?maxAge=3600)](https://github.com/Requarks/wiki/releases)`
Updated README.md 2016-08-17 01:13:48 +00:00			`[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg)](https://github.com/requarks/wiki/blob/master/LICENSE)`
Fixed issue with social accounts with empty name 2017-02-07 19:36:10 +00:00			`[![Github All Releases](https://img.shields.io/github/downloads/Requarks/wiki/total.svg)](https://github.com/Requarks/wiki/releases/latest)`
Updated README.md 2016-08-17 01:13:48 +00:00			`[![Build Status](https://travis-ci.org/Requarks/wiki.svg?branch=master)](https://travis-ci.org/Requarks/wiki)`
			`[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1d0217a3153c4595bdedb322263e55c8)](https://www.codacy.com/app/Requarks/wiki)`
Fixed Gemnasium badge 2016-08-17 01:15:49 +00:00			`[![Dependency Status](https://gemnasium.com/badges/github.com/Requarks/wiki.svg)](https://gemnasium.com/github.com/Requarks/wiki)`
Updated README.md 2016-08-17 01:13:48 +00:00			`[![Known Vulnerabilities](https://snyk.io/test/github/requarks/wiki/badge.svg)](https://snyk.io/test/github/requarks/wiki)`

			`##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown`
Files Management + Editor Modal + Code Editor fixes 2016-12-22 01:38:12 +00:00			`Under active development`
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			`- [Official Website](https://wiki.requarks.io/)`
			`- [Installation Guide](https://wiki.requarks.io/get-started.html)`
Removed inch badge 2016-10-17 23:41:14 +00:00
Updated README.md 2016-08-17 01:13:48 +00:00			`##### Milestones`
Added nodejs 7 testing 2017-01-28 00:17:54 +00:00			`- [x] Account Management`
Updated milestones 2017-01-31 01:26:14 +00:00			`- [x] Profile`
			`- [x] Manage users`
Updated milestones 2017-02-10 06:49:34 +00:00			`- [x] Create local account`
Visual update 2016-12-16 03:59:58 +00:00			`- [x] Assets Management`
Added Social Authentication + fixed Agent Cron 2016-10-30 22:41:10 +00:00			`- [x] Images`
Files Management + Editor Modal + Code Editor fixes 2016-12-22 01:38:12 +00:00			`- [x] Files/Documents`
Local authentication 2016-10-31 03:03:36 +00:00			`- [x] Authentication`
Added access rights feature + read access check 2016-11-01 02:44:00 +00:00			`- [x] Strategies`
			`- [x] Local`
			`- [x] Microsoft Account`
			`- [x] Google ID`
			`- [x] Facebook`
			`- [x] Access Rights`
			`- [x] View`
Added access check for write and manage actions 2017-01-03 04:32:16 +00:00			`- [x] Edit / Create`
Added Background Agent (git resync + cache purge) 2016-09-01 02:45:28 +00:00			`- [x] Background Agent (git sync, cache purge, etc.)`
Updated milestones 2016-08-28 01:51:45 +00:00			`- [x] Caching`
Create mode + Source view + UI enhancements 2016-08-30 02:19:47 +00:00			`- [x] Create Entry`
Welcome page + project renaming leftovers 2016-12-09 03:44:31 +00:00			`- [x] Documentation`
			`- [x] Prerequisites`
			`- [x] Install`
Fixed issue with social accounts with empty name 2017-02-07 19:36:10 +00:00			`- [x] Authentication`
Added access check for write and manage actions 2017-01-03 04:32:16 +00:00			`- [x] Git`
Update README.md 2016-12-19 19:05:05 +00:00			`- [x] Upgrade`
Create mode + Source view + UI enhancements 2016-08-30 02:19:47 +00:00			`- [x] Edit Entry`
Updated milestones 2016-08-28 01:51:45 +00:00			`- [x] Git Management`
Visual update 2016-12-16 03:59:58 +00:00			`- [x] Markdown Editor`
Added Social Authentication + fixed Agent Cron 2016-10-30 22:41:10 +00:00			`- [x] Basic Formatting`
Added nodejs 7 testing 2017-01-28 00:17:54 +00:00			`- [ ] Insert Link modal`
Files Management + Editor Modal + Code Editor fixes 2016-12-22 01:38:12 +00:00			`- [x] Image Selection modal`
			`- [x] File Selection modal`
Video player modal + provider match 2017-01-03 03:20:24 +00:00			`- [x] Video player`
Files Management + Editor Modal + Code Editor fixes 2016-12-22 01:38:12 +00:00			`- [x] Inline Code`
			`- [x] Code Editor modal`
Added nodejs 7 testing 2017-01-28 00:17:54 +00:00			`- [ ] Table Visual Editor`
Added move document feature 2016-09-09 23:22:18 +00:00			`- [x] Move Entry`
Updated milestones 2016-08-28 01:51:45 +00:00			`- [x] Navigation`
			`- [x] Parsing / Tree / Metadata`
Search results + suggestions 2016-09-05 18:11:51 +00:00			`- [x] Search`
Added Background Agent (git resync + cache purge) 2016-09-01 02:45:28 +00:00			`- [x] UI`
Update README.md 2016-12-19 19:05:05 +00:00			`- [x] View Entry Source`

Added DigitalOcean sponsor 2016-12-23 18:31:10 +00:00			`### Special Thanks`
Update README.md 2016-12-19 19:05:05 +00:00
Updated milestones 2017-02-10 06:49:34 +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
Updated milestones 2017-02-10 06:49:34 +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.`