mirror of https://github.com/requarks/wiki
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
138 lines
6.5 KiB
138 lines
6.5 KiB
|
|
|
|
[](https://github.com/Requarks/wiki/releases)
|
|
[](https://github.com/requarks/wiki/blob/master/LICENSE)
|
|
[](https://www.npmjs.com/package/wiki.js)
|
|
[](https://www.npmjs.com/package/wiki.js)
|
|
[](https://twitter.com/requarks)
|
|
[](https://app.wercker.com/project/byKey/fc8e75793b3cf12852314d6bfd83d148)
|
|
[](https://www.codacy.com/app/Requarks/wiki)
|
|
[](https://gemnasium.com/github.com/Requarks/wiki)
|
|
[](http://standardjs.com/)
|
|
[](https://gitter.im/Requarks/wiki)
|
|
|
|
##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
|
|
|
|
- **[Official Website](https://wiki.js.org/)**
|
|
- **[Getting Started](https://wiki.js.org/get-started.html)**
|
|
- **[Documentation](https://docs.requarks.io/wiki/)**
|
|
- [Requirements](#requirements)
|
|
- [Change Log](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md)
|
|
- [Feature Requests](https://wikijs.canny.io/features)
|
|
- [Milestones](#milestones)
|
|
- [Chat with us](#gitter)
|
|
- [Translations](#translations) *(We need your help!)*
|
|
- [Special Thanks](#special-thanks)
|
|
|
|
## Requirements
|
|
|
|
Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.).
|
|
|
|
- Node.js **6.11.1** or later
|
|
- MongoDB **3.2** or later
|
|
- Git **2.7.4** or later
|
|
- An empty Git repository (optional)
|
|
|
|
> Read the full [prerequisites](https://docs.requarks.io/wiki/prerequisites) article for full details.
|
|
|
|
## Cloud Install
|
|
|
|
[](https://heroku.com/deploy?template=https://github.com/requarks/wiki-heroku)
|
|
|
|
*Docker Cloud, Azure, IBM Bluemix and more coming soon!*
|
|
|
|
## Docker
|
|
|
|
A docker Wiki.js image is available on Docker Hub:
|
|
|
|
[](https://hub.docker.com/r/requarks/wiki/)
|
|
|
|
You can also use a Dockerfile ([see example](https://github.com/Requarks/wiki/blob/master/tools/Dockerfile)) or Docker Compose ([see example](https://github.com/Requarks/wiki/blob/master/tools/docker-compose.yml)) to run Wiki.js.
|
|
|
|
## Milestones
|
|
|
|
Current and upcoming milestones *(major features only, see the [changelog](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md) for complete list of features and bug fixes)*:
|
|
|
|
### 1.0.0 - Beta 13
|
|
|
|
|
|
- [x] Color Themes
|
|
- [x] Server-side TeX/MathML rendering
|
|
- [x] Render line breaks by default (GitHub style)
|
|
- [x] New Localization: German
|
|
|
|
### 1.0.6 - Stable
|
|
|
|
|
|
- [x] Bug fixes release
|
|
- [x] New Localization: Dutch
|
|
|
|
### 2.0.0 - Dev
|
|
|
|
|
|
**Breaking Changes**: MongoDB is being phased out in favor of PostgreSQL + Redis. An upgrade tool will be provided to migrate existing data to the new system.
|
|
|
|
- [ ] GraphQL API
|
|
- [x] Comments
|
|
- [x] Documents
|
|
- [ ] Files
|
|
- [x] Folders
|
|
- [x] Groups
|
|
- [x] Rights
|
|
- [x] Settings
|
|
- [x] Tags
|
|
- [x] Users
|
|
- [x] Migrate to PostgreSQL + Redis datastore
|
|
- [ ] History / Revert to previous version
|
|
- [ ] Optional Two-Steps Authentication (2FA)
|
|
- [x] Docker support + Auto compile/publish to Docker Hub
|
|
- [ ] Support sub-directory installations (e.g. example.com/wiki)
|
|
- [ ] Persist system settings to database instead of file-based
|
|
- [ ] User Groups + Better permissions management
|
|
- [x] Make use of all available CPU cores, distributed jobs queue
|
|
- [ ] Tags per document / folder
|
|
- [ ] Comments / Discussion per document
|
|
- [ ] Profile page per user
|
|
- [ ] Preview changes directly from the editor, without saving
|
|
- [x] Modular authentication providers
|
|
- [ ] High Availability support (multiple concurrent instances)
|
|
|
|
### Future
|
|
|
|
- [ ] Insert Link modal in Editor
|
|
- [ ] Better simultaneous user editing handling
|
|
- [ ] Upgrade from web UI
|
|
|
|
## Gitter
|
|
|
|
Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly!
|
|
|
|
## Twitter
|
|
|
|
Follow our Twitter feed to learn about upcoming updates and new releases!
|
|
[](https://twitter.com/requarks)
|
|
|
|
## Translations
|
|
|
|
We are looking for translators to make Wiki.js available in multiple languages. If your language is not listed below and would like to contribute to this project, contact us on our [gitter channel](https://gitter.im/Requarks/wiki) and we'll provide you with the necessary tool to add translations, no coding required!
|
|
|
|
**Languages that are already translated:**
|
|
|
|
- [x] English
|
|
- [x] Chinese - *Thanks to [@choicky](https://github.com/choicky)*
|
|
- [x] Dutch - *Thanks to [@weirdwater](https://github.com/weirdwater)*
|
|
- [x] French
|
|
- [x] German - *Thanks to [@joetjengerdes](https://github.com/joetjengerdes)*
|
|
- [x] Korean - *Thanks to [@junwonpk](https://github.com/junwonpk)*
|
|
- [x] Portuguese - *Thanks to [@felipeplets](https://github.com/felipeplets)*
|
|
- [x] Russian - *Thanks to [@efimlosev](https://github.com/efimlosev)*
|
|
- [x] Spanish - *Thanks to [@MatiasArriola](https://github.com/MatiasArriola)*
|
|
|
|
## Special Thanks
|
|
|
|
|
|
[Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.
|
|
|
|
|
|
[DigitalOcean](https://www.digitalocean.com/) for providing hosting of the Wiki.js documentation site.
|