<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)
[![Github All Releases](https://img.shields.io/github/downloads/Requarks/wiki/total.svg?style=flat-square)](https://github.com/Requarks/wiki/releases/latest)
[![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
*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.