wikijs-fork/README.md

75 lines
2.7 KiB
Markdown
Raw Normal View History

2016-08-17 18:39:30 +00:00
<a href="https://github.com/Requarks/wiki">
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" />
2016-08-17 18:39:30 +00:00
</a>
2016-12-06 02:42:41 +00:00
# Wiki.js
2016-08-17 01:13:48 +00:00
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)
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)
[![Github All Releases](https://img.shields.io/github/downloads/Requarks/wiki/total.svg)](https://github.com/Requarks/wiki/releases/latest)
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)
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)
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)
2017-02-10 18:13:40 +00:00
[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
2016-08-17 01:13:48 +00:00
##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
*Under active development*
2016-08-17 01:13:48 +00:00
2016-10-17 23:41:14 +00:00
### Documentation
- [Official Website](https://wiki.requarks.io/)
- [Installation Guide](https://wiki.requarks.io/get-started.html)
2016-10-17 23:41:14 +00:00
2016-08-17 01:13:48 +00:00
##### Milestones
2017-01-28 00:17:54 +00:00
- [x] Account Management
2017-01-31 01:26:14 +00:00
- [x] Profile
- [x] Manage users
2017-02-10 06:49:34 +00:00
- [x] Create local account
2016-12-16 03:59:58 +00:00
- [x] Assets Management
- [x] Images
- [x] Files/Documents
2016-10-31 03:03:36 +00:00
- [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.)
2016-08-28 01:51:45 +00:00
- [x] Caching
- [x] Create Entry
- [x] Documentation
- [x] Prerequisites
- [x] Install
- [x] Authentication
- [x] Git
2016-12-19 19:05:05 +00:00
- [x] Upgrade
- [x] Edit Entry
2016-08-28 01:51:45 +00:00
- [x] Git Management
2016-12-16 03:59:58 +00:00
- [x] Markdown Editor
- [x] Basic Formatting
2017-01-28 00:17:54 +00:00
- [ ] Insert Link modal
- [x] Image Selection modal
- [x] File Selection modal
2017-01-03 03:20:24 +00:00
- [x] Video player
- [x] Inline Code
- [x] Code Editor modal
2017-01-28 00:17:54 +00:00
- [ ] Table Visual Editor
2016-09-09 23:22:18 +00:00
- [x] Move Entry
2016-08-28 01:51:45 +00:00
- [x] Navigation
- [x] Parsing / Tree / Metadata
2016-09-05 18:11:51 +00:00
- [x] Search
- [x] UI
2016-12-19 19:05:05 +00:00
- [x] View Entry Source
2016-12-23 18:31:10 +00:00
### Special Thanks
2016-12-19 19:05:05 +00:00
2017-02-10 18:13:40 +00:00
![Browserstack](https://wiki.requarks.io/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-02-10 18:13:40 +00:00
![DigitalOcean](https://wiki.requarks.io/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.