2016-08-17 14:39:30 -04:00
|
|
|
<a href="https://github.com/Requarks/wiki">
|
2016-12-05 21:42:41 -05:00
|
|
|
<img src="https://raw.githubusercontent.com/Requarks/wiki/master/assets/favicons/favicon-96x96.png" alt="Wiki.js" title="Wiki.js" align="right" />
|
2016-08-17 14:39:30 -04:00
|
|
|
</a>
|
|
|
|
|
2016-12-05 21:42:41 -05:00
|
|
|
# Wiki.js
|
2016-08-16 21:13:48 -04:00
|
|
|
|
2017-01-27 23:39:29 -05:00
|
|
|
[![Release](https://img.shields.io/github/release/Requarks/wiki.svg?maxAge=3600)](https://github.com/Requarks/wiki/releases)
|
2016-08-16 21:13:48 -04:00
|
|
|
[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg)](https://github.com/requarks/wiki/blob/master/LICENSE)
|
2017-02-07 14:36:10 -05:00
|
|
|
[![Github All Releases](https://img.shields.io/github/downloads/Requarks/wiki/total.svg)](https://github.com/Requarks/wiki/releases/latest)
|
2016-08-16 21:13:48 -04: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)
|
2016-08-16 21:15:49 -04:00
|
|
|
[![Dependency Status](https://gemnasium.com/badges/github.com/Requarks/wiki.svg)](https://gemnasium.com/github.com/Requarks/wiki)
|
2016-08-16 21:13:48 -04:00
|
|
|
[![Known Vulnerabilities](https://snyk.io/test/github/requarks/wiki/badge.svg)](https://snyk.io/test/github/requarks/wiki)
|
2017-02-10 13:13:40 -05:00
|
|
|
[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
|
2016-08-16 21:13:48 -04:00
|
|
|
|
|
|
|
##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
|
2016-12-21 20:38:12 -05:00
|
|
|
*Under active development*
|
2016-08-16 21:13:48 -04:00
|
|
|
|
2016-10-17 19:41:14 -04:00
|
|
|
### Documentation
|
|
|
|
|
2016-12-21 20:38:12 -05:00
|
|
|
- [Official Website](https://wiki.requarks.io/)
|
|
|
|
- [Installation Guide](https://wiki.requarks.io/get-started.html)
|
2016-10-17 19:41:14 -04:00
|
|
|
|
2016-08-16 21:13:48 -04:00
|
|
|
##### Milestones
|
2017-01-27 19:17:54 -05:00
|
|
|
- [x] Account Management
|
2017-01-30 20:26:14 -05:00
|
|
|
- [x] Profile
|
|
|
|
- [x] Manage users
|
2017-02-10 01:49:34 -05:00
|
|
|
- [x] Create local account
|
2016-12-15 22:59:58 -05:00
|
|
|
- [x] Assets Management
|
2016-10-30 18:41:10 -04:00
|
|
|
- [x] Images
|
2016-12-21 20:38:12 -05:00
|
|
|
- [x] Files/Documents
|
2016-10-30 23:03:36 -04:00
|
|
|
- [x] Authentication
|
2016-10-31 22:44:00 -04:00
|
|
|
- [x] Strategies
|
|
|
|
- [x] Local
|
|
|
|
- [x] Microsoft Account
|
|
|
|
- [x] Google ID
|
|
|
|
- [x] Facebook
|
|
|
|
- [x] Access Rights
|
|
|
|
- [x] View
|
2017-01-02 23:32:16 -05:00
|
|
|
- [x] Edit / Create
|
2016-08-31 22:45:28 -04:00
|
|
|
- [x] Background Agent (git sync, cache purge, etc.)
|
2016-08-27 21:51:45 -04:00
|
|
|
- [x] Caching
|
2016-08-29 22:19:47 -04:00
|
|
|
- [x] Create Entry
|
2016-12-08 22:44:31 -05:00
|
|
|
- [x] Documentation
|
|
|
|
- [x] Prerequisites
|
|
|
|
- [x] Install
|
2017-02-07 14:36:10 -05:00
|
|
|
- [x] Authentication
|
2017-01-02 23:32:16 -05:00
|
|
|
- [x] Git
|
2016-12-19 14:05:05 -05:00
|
|
|
- [x] Upgrade
|
2016-08-29 22:19:47 -04:00
|
|
|
- [x] Edit Entry
|
2016-08-27 21:51:45 -04:00
|
|
|
- [x] Git Management
|
2016-12-15 22:59:58 -05:00
|
|
|
- [x] Markdown Editor
|
2016-10-30 18:41:10 -04:00
|
|
|
- [x] Basic Formatting
|
2017-01-27 19:17:54 -05:00
|
|
|
- [ ] Insert Link modal
|
2016-12-21 20:38:12 -05:00
|
|
|
- [x] Image Selection modal
|
|
|
|
- [x] File Selection modal
|
2017-01-02 22:20:24 -05:00
|
|
|
- [x] Video player
|
2016-12-21 20:38:12 -05:00
|
|
|
- [x] Inline Code
|
|
|
|
- [x] Code Editor modal
|
2017-01-27 19:17:54 -05:00
|
|
|
- [ ] Table Visual Editor
|
2016-09-09 19:22:18 -04:00
|
|
|
- [x] Move Entry
|
2016-08-27 21:51:45 -04:00
|
|
|
- [x] Navigation
|
|
|
|
- [x] Parsing / Tree / Metadata
|
2016-09-05 14:11:51 -04:00
|
|
|
- [x] Search
|
2016-08-31 22:45:28 -04:00
|
|
|
- [x] UI
|
2016-12-19 14:05:05 -05:00
|
|
|
- [x] View Entry Source
|
|
|
|
|
2016-12-23 13:31:10 -05:00
|
|
|
### Special Thanks
|
2016-12-19 14:05:05 -05:00
|
|
|
|
2017-02-10 13:13:40 -05:00
|
|
|
![Browserstack](https://wiki.requarks.io/assets/images/logo_browserstack.png)
|
2016-12-19 14:05:05 -05:00
|
|
|
[Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.
|
2016-12-23 13:31:10 -05:00
|
|
|
|
2017-02-10 13:13:40 -05:00
|
|
|
![DigitalOcean](https://wiki.requarks.io/assets/images/logo_digitalocean.png)
|
2016-12-23 13:31:10 -05:00
|
|
|
[DigitalOcean](https://www.digitalocean.com/) for providing hosting of the Wiki.js documentation site.
|