wikijs-fork/README.md

53 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-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)
2017-02-16 17:49:56 +00:00
[![npm Downloads](https://img.shields.io/npm/dt/wiki.js.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js)
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/)
2016-08-17 01:13:48 +00:00
##### 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](#change-log)
- [Special Thanks](#special-thanks)
2016-08-17 01:13:48 +00:00
2016-10-17 23:41:14 +00:00
### 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 v**4.6.0** or later
- MongoDB v**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.
### Change Log
2016-10-17 23:41:14 +00:00
View all notable changes between releases in the [changelog](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md).
2016-12-19 19:05:05 +00:00
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.