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.

118 lines
5.7 KiB

7 years ago
8 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
  1. ![Wiki.js](https://raw.githubusercontent.com/Requarks/wiki-site/1.0/assets/images/logo.png)
  2. [![Release](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat-square&maxAge=3600)](https://github.com/Requarks/wiki/releases)
  3. [![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat-square)](https://github.com/requarks/wiki/blob/master/LICENSE)
  4. [![npm](https://img.shields.io/badge/npm-wiki.js-blue.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js)
  5. [![Downloads](https://img.shields.io/github/downloads/Requarks/wiki/total.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js)
  6. [![Twitter Follow](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat-square)](https://twitter.com/requarks)
  7. [![Build Status](https://app.wercker.com/status/fc8e75793b3cf12852314d6bfd83d148/s/master?style=flat-square)](https://app.wercker.com/project/byKey/fc8e75793b3cf12852314d6bfd83d148)
  8. [![Codacy Badge](https://img.shields.io/codacy/grade/1d0217a3153c4595bdedb322263e55c8/master.svg?style=flat-square)](https://www.codacy.com/app/Requarks/wiki)
  9. [![Dependency Status](https://img.shields.io/gemnasium/Requarks/wiki.svg?style=flat-square)](https://gemnasium.com/github.com/Requarks/wiki)
  10. [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)
  11. [![Chat on Gitter](https://img.shields.io/badge/chat-on_gitter-CC2B5E.svg?style=flat-square&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAOCAMAAADUg/YpAAAABlBMVEUAAAD///%2Bl2Z/dAAAAAXRSTlMAQObYZgAAABVJREFUeAFjwAUYYTQByAAh0WicAAAFnwAYeB5bLwAAAABJRU5ErkJggg==)](https://gitter.im/Requarks/wiki)
  12. ##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
  13. - [Official Website](https://wiki.js.org/)
  14. - [Documentation](#documentation)
  15. - [Requirements](#requirements)
  16. - [Change Log](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md)
  17. - [Feature Requests](https://wikijs.canny.io/features)
  18. - [Milestones](#milestones)
  19. - [Chat with us](#gitter)
  20. - [Translations](#translations) *(We need your help!)*
  21. - [Special Thanks](#special-thanks)
  22. ## Documentation
  23. - [Installation Guide](https://wiki.js.org/get-started.html)
  24. - [Admin Guide](https://docs.requarks.io/wiki/#admin-guide)
  25. - [User Guide](https://docs.requarks.io/wiki/#user-guide)
  26. ## Requirements
  27. Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.).
  28. - Node.js **6.11.1** or later
  29. - MongoDB **3.2** or later
  30. - Git **2.7.4** or later
  31. - An empty Git repository (optional)
  32. > Read the full [prerequisites](https://docs.requarks.io/wiki/prerequisites) article for full details.
  33. ## Cloud Install
  34. [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/requarks/wiki-heroku)
  35. *Docker, Azure and more coming soon!*
  36. ## Milestones
  37. 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)*:
  38. ### 1.0.0 - Beta 13
  39. ![Progress](http://progressed.io/bar/100)
  40. - [x] Color Themes
  41. - [x] Server-side TeX/MathML rendering
  42. - [x] Render line breaks by default (GitHub style)
  43. - [x] New Localization: German
  44. ### 1.0.3 - Stable
  45. ![Progress](http://progressed.io/bar/100)
  46. - [x] Bug fixes release
  47. ### 2.0.0 - Dev
  48. ![Progress](http://progressed.io/bar/20)
  49. **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.
  50. - [ ] GraphQL API
  51. - [ ] Migrate to PostgreSQL + Redis datastore
  52. - [ ] History / Revert to previous version
  53. - [ ] Optional Two-Steps Authentication (2FA)
  54. - [ ] Docker support + Auto compile/publish to Docker Hub
  55. - [ ] Support sub-directory installations (e.g. example.com/wiki)
  56. - [ ] Persist system settings to database instead of file-based
  57. - [ ] User Groups + Better permissions management
  58. ### Future
  59. - [ ] Insert Link modal in Editor
  60. - [ ] Better simultaneous user editing handling
  61. - [ ] Preview changes directly from the editor, without saving
  62. - [ ] Upgrade from web UI
  63. ## Gitter
  64. Want to discuss features, ideas or issues? Join our [gitter channel](https://gitter.im/Requarks/wiki). We are very active and friendly!
  65. ## Twitter
  66. Follow our Twitter feed to learn about upcoming updates and new releases!
  67. [![Twitter Follow](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat-square)](https://twitter.com/requarks)
  68. ## Translations
  69. 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!
  70. **Languages that are already translated:**
  71. - [x] English
  72. - [x] Chinese - *Thanks to [@choicky](https://github.com/choicky)*
  73. - [x] Dutch - *Thanks to [@weirdwater](https://github.com/weirdwater)*
  74. - [x] French
  75. - [x] German - *Thanks to [@joetjengerdes](https://github.com/joetjengerdes)*
  76. - [x] Korean - *Thanks to [@junwonpk](https://github.com/junwonpk)*
  77. - [x] Portuguese - *Thanks to [@felipeplets](https://github.com/felipeplets)*
  78. - [x] Russian - *Thanks to [@efimlosev](https://github.com/efimlosev)*
  79. - [x] Spanish - *Thanks to [@MatiasArriola](https://github.com/MatiasArriola)*
  80. ## Special Thanks
  81. ![Browserstack](https://wiki.js.org/assets/images/logo_browserstack.png)
  82. [Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.
  83. ![DigitalOcean](https://wiki.js.org/assets/images/logo_digitalocean.png)
  84. [DigitalOcean](https://www.digitalocean.com/) for providing hosting of the Wiki.js documentation site.