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.

247 lines
16 KiB

8 years ago
  1. <div align="center">
  2. <img src="https://static.requarks.io/logo/wikijs-full.svg" alt="Wiki.js" width="600" />
  3. [![Release](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat&maxAge=3600)](https://github.com/Requarks/wiki/releases)
  4. [![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat)](https://github.com/requarks/wiki/blob/master/LICENSE)
  5. [![Backers on Open Collective](https://opencollective.com/wikijs/all/badge.svg)](https://opencollective.com/wikijs)
  6. [![Downloads](https://img.shields.io/github/downloads/Requarks/wiki/total.svg?style=flat)](https://github.com/Requarks/wiki/releases)
  7. [![Docker Pulls](https://img.shields.io/docker/pulls/requarks/wiki.svg)](https://hub.docker.com/r/requarks/wiki/)
  8. [![Build status](https://dev.azure.com/requarks/wiki/_apis/build/status/build)](https://dev.azure.com/requarks/wiki/_build/latest?definitionId=9)
  9. [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=wiki&metric=alert_status)](https://sonarcloud.io/dashboard?id=wiki)
  10. [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=wiki&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=wiki)
  11. [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=wiki&metric=security_rating)](https://sonarcloud.io/dashboard?id=wiki)
  12. [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
  13. [![Chat on Slack](https://img.shields.io/badge/slack-requarks-CC2B5E.svg?style=flat&logo=slack)](https://wiki.requarks.io/slack)
  14. [![Twitter Follow](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat&logo=twitter)](https://twitter.com/requarks)
  15. [![Subscribe to Newsletter](https://img.shields.io/badge/newsletter-subscribe-yellow.svg?style=flat&logo=mailchimp)](https://wiki.js.org/newsletter)
  16. ##### A modern, lightweight and powerful wiki app built on NodeJS
  17. </div>
  18. - **[Official Website](https://wiki.js.org/)**
  19. - **[Documentation](https://docs.requarks.io/)**
  20. - [Requirements](https://docs.requarks.io/install/requirements)
  21. - [Installation](https://docs.requarks.io/install)
  22. - [Demo](https://docs.requarks.io/demo)
  23. - [Change Log](https://docs.requarks.io/releases)
  24. - [Feature Requests](https://wiki.js.org/feedback)
  25. - [Chat with us on Slack](https://wiki.requarks.io/slack)
  26. - [Translations](https://docs.requarks.io/dev/translations) *(We need your help!)*
  27. - [E2E Testing Results](https://dashboard.cypress.io/projects/r7qxah/runs)
  28. - [Special Thanks](#special-thanks)
  29. - [Contribute](#contributors)
  30. [Follow our Twitter feed](https://twitter.com/requarks) to learn about upcoming updates and new releases!
  31. <h2 align="center">Donate</h2>
  32. <div align="center">
  33. Wiki.js is an open source project that has been made possible due to the generous contributions by community [backers](https://wiki.js.org/about). If you are interested in supporting this project, please consider [becoming a sponsor](https://github.com/users/NGPixel/sponsorship), [becoming a patron](https://www.patreon.com/requarks), donating to our [OpenCollective](https://opencollective.com/wikijs), via [Paypal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FLV5X255Z9CJU&source=url) or via Ethereum (`0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5`).
  34. [![Become a Sponsor](https://img.shields.io/badge/donate-github-ea4aaa.svg?style=popout&logo=github)](https://github.com/users/NGPixel/sponsorship)
  35. [![Become a Patron](https://img.shields.io/badge/donate-patreon-orange.svg?style=popout&logo=patreon)](https://www.patreon.com/requarks)
  36. [![Donate on OpenCollective](https://img.shields.io/badge/donate-open%20collective-blue.svg?style=popout&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48c3ZnIHdpZHRoPSIyNTZweCIgaGVpZ2h0PSIyNTZweCIgdmlld0JveD0iMCAwIDI1NiAyNTYiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQiPjxnPjxwYXRoIGQ9Ik0yMDkuNzY1MTQ0LDEyOC4xNDk5NzkgQzIwOS43NjUxNDQsMTQ0LjE2MzMgMjA0Ljg2NDM4MSwxNTkuNDg5ODkgMTk2LjQ5ODc0NywxNzIuNzI1MDcyIEwyMjkuOTQ1Njc1LDIwNi4xNzE5OTkgQzI0Ni42ODIxMDUsMTgzLjg1Njc1OSAyNTUuNzI5MzA3LDE1Ni43MTUxNTIgMjU1LjcyOTMwNywxMjguODIxMTAyIEMyNTUuNzI5MzA3LDk5LjU1Njk5MTcgMjQ1Ljk3NDYwMyw3My4wNzEwMjA3IDIyOS4yNTg5NDQsNTEuNDg1ODEyOCBMMTk2LjQ4MzE0LDg0LjIxNDc5NCBDMjA1LjEyMjU2MSw5Ny4yMjI0NjgzIDIwOS43MzY5MDcsMTEyLjQ4NzgxIDIwOS43NDk1MzcsMTI4LjEwMzE1NiBMMjA5Ljc2NTE0NCwxMjguMTQ5OTc5IFoiIGZpbGw9IiNCOEQzRjQiPjwvcGF0aD48cGF0aCBkPSJNMTI3LjUxMzQ4NCwyMTAuMzU0ODE2IEM4Mi4xNDYwODcyLDIxMC4yNjg5NTggNDUuMzg3NTA5NCwxNzMuNTE3MzU4IDQ1LjI5MzAzOTMsMTI4LjE0OTk3OSBDNDUuMzYxNzUwMiw4Mi43NjQzMTM4IDgyLjEyNzg0ODcsNDUuOTg0MjU3IDEyNy41MTM0ODQsNDUuODk4MzE4NiBDMTQ0LjI0NDc1Miw0NS44OTgzMTg2IDE1OS41NzEzNDIsNTAuNzk5MDgxNyAxNzIuMTE5NzkyLDU5LjE2NDcxNTQgTDIwNC44NjQzODEsMjYuMzg4OTExNiBDMTgyLjU0MzY1LDkuNjY2NjUxMjkgMTU1LjQwMzQyOSwwLjYzMDg2MzI5OCAxMjcuNTEzNDg0LDAuNjM2NDk0NDAzIEM1Ny4xMjM1NDM3LDAuNjM2NDk0NDAzIDAsNTcuNzYwMDM4MSAwLDEyOC4xNDk5NzkgQzAsMTk4LjUwODcwNCA1Ny4xMjM1NDM3LDI1NS42NjM0NjMgMTI3LjUxMzQ4NCwyNTUuNjYzNDYzIEMxNTUuNTM3MzUyLDI1NS43NDA4NzYgMTgyLjc3NTk4OSwyNDYuNDA4NTEgMjA0Ljg2NDM4MSwyMjkuMTYxODg0IEwxNzEuNDE3NDU0LDE5NS43MzA1NjQgQzE1OS41NTU3MzQsMjA1LjQ4NTI2OCAxNDQuMjYwMzU5LDIxMC4zNTQ4MTYgMTI3LjUxMzQ4NCwyMTAuMzU0ODE2IEwxMjcuNTEzNDg0LDIxMC4zNTQ4MTYgWiIgZmlsbD0iIzdGQURGMiI+PC9wYXRoPjwvZz48L3N2Zz4=)](https://opencollective.com/wikijs)
  37. [![Donate via Paypal](https://img.shields.io/badge/donate-paypal-blue.svg?style=popout&logo=paypal)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FLV5X255Z9CJU&source=url)
  38. [![Donate via Ethereum](https://img.shields.io/badge/donate-ethereum-999.svg?style=popout&logo=ethereum&logoColor=CCC)](https://etherscan.io/address/0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5)
  39. [![Donate via Bitcoin](https://img.shields.io/badge/donate-bitcoin-ff9900.svg?style=popout&logo=bitcoin&logoColor=CCC)](https://checkout.opennode.com/p/2553c612-f863-4407-82b3-1a7685268747)
  40. [![Buy a T-Shirt](https://img.shields.io/badge/buy-t--shirts-teal.svg?style=popout&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHg9IjBweCIgeT0iMHB4Igp3aWR0aD0iMjQiIGhlaWdodD0iMjQiCnZpZXdCb3g9IjAgMCAxOTIgMTkyIgpzdHlsZT0iIGZpbGw6IzAwMDAwMDsiPjxnIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0ibm9uemVybyIgc3Ryb2tlPSJub25lIiBzdHJva2Utd2lkdGg9IjEiIHN0cm9rZS1saW5lY2FwPSJidXR0IiBzdHJva2UtbGluZWpvaW49Im1pdGVyIiBzdHJva2UtbWl0ZXJsaW1pdD0iMTAiIHN0cm9rZS1kYXNoYXJyYXk9IiIgc3Ryb2tlLWRhc2hvZmZzZXQ9IjAiIGZvbnQtZmFtaWx5PSJub25lIiBmb250LXdlaWdodD0ibm9uZSIgZm9udC1zaXplPSJub25lIiB0ZXh0LWFuY2hvcj0ibm9uZSIgc3R5bGU9Im1peC1ibGVuZC1tb2RlOiBub3JtYWwiPjxwYXRoIGQ9Ik0wLDE5MnYtMTkyaDE5MnYxOTJ6IiBmaWxsPSJub25lIj48L3BhdGg+PGcgZmlsbD0iIzFhYmM5YyI+PGcgaWQ9InN1cmZhY2UxIj48cGF0aCBkPSJNOTYsMGMtMTUuMjE4NzUsMCAtMjQuNjg3NSwzLjY1NjI1IC0yNS41LDRsLTIyLjUsNy4yNWMtMTAuNDA2MjUsMy4xODc1IC0xOS4wOTM3NSw5LjQzNzUgLTI1LjUsMTguMjVsLTIyLjUsNDIuNWwyNy4yNSwxNi43NWwxMi43NSwtMjR2MTE5LjI1YzAsNC40MDYyNSAyNS4wNjI1LDggNTYsOGMzMC45Mzc1LDAgNTYsLTMuNTkzNzUgNTYsLTh2LTExOS4yNWwxMi43NSwyNGwyNy4yNSwtMTYuNzVsLTIyLjUsLTQyLjVjLTYuNDA2MjUsLTguODEyNSAtMTUuMTU2MjUsLTE1LjA2MjUgLTI0Ljc1LC0xOC4yNWwtMjIuMjUsLTcuMjVjLTAuMTg3NSwwIC0xLjAzMTI1LDEuMzEyNSAtMiwyLjc1bDEuMjUsLTIuNWMwLDAgLTkuODQzNzUsLTQuMjUgLTI1Ljc1LC00LjI1ek05Niw4YzExLjQwNjI1LDAgMTguNDM3NSwyLjI1IDIxLDMuMjVjLTQuNDY4NzUsNS43NSAtMTEuNDA2MjUsMTIuNzUgLTIxLDEyLjc1Yy05LjQwNjI1LDAgLTE2LjQwNjI1LC03LjA2MjUgLTIwLjc1LC0xMi43NWMyLjg3NSwtMS4wNjI1IDkuODc1LC0zLjI1IDIwLjc1LC0zLjI1eiI+PC9wYXRoPjwvZz48L2c+PC9nPjwvc3ZnPg==)](https://wikijs.threadless.com)
  41. </div>
  42. <h2 align="center">GitHub Sponsors</h2>
  43. Support this project by becoming a sponsor. Your name will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [[Become a sponsor](https://github.com/users/NGPixel/sponsorship)]
  44. <div align="center">
  45. <table>
  46. <tbody>
  47. <tr>
  48. <td align="center" valign="middle" width="148">
  49. <a href="https://github.com/alexksso" target="_blank">
  50. Alexander Casassovici<br />(@alexksso)
  51. </a>
  52. </td>
  53. <td align="center" valign="middle" width="148">
  54. <a href="https://github.com/xDacon" target="_blank">
  55. Dacon<br />(@xDacon)
  56. </a>
  57. </td>
  58. <td align="center" valign="middle" width="148">
  59. <a href="https://github.com/GigabiteLabs" target="_blank">
  60. <img src="https://static.requarks.io/sponsors/gigabitelabs-148x129.png">
  61. </a>
  62. </td>
  63. <td align="center" valign="middle" width="148">
  64. <a href="https://github.com/idokka" target="_blank">
  65. Oleksii<br />(@idokka)
  66. </a>
  67. </td>
  68. <td align="center" valign="middle" width="148">
  69. <a href="https://github.com/TheodoreChu" target="_blank">
  70. Theodore Chu<br />(@TheodoreChu)
  71. </a>
  72. </td>
  73. <td align="center" valign="middle" width="148">
  74. <a href="https://github.com/sponsors/NGPixel" target="_blank">
  75. <img src="https://static.requarks.io/sponsors/become-148x72.png">
  76. </a>
  77. </td>
  78. </tr>
  79. </tbody>
  80. </table>
  81. </div>
  82. - Akira Suenami ([@a-suenami](https://github.com/a-suenami))
  83. - Bryon Vandiver ([@asterick](https://github.com/asterick))
  84. - CrazyMarvin ([@CrazyMarvin](https://github.com/CrazyMarvin))
  85. - David Christian Holin ([@SirGibihm](https://github.com/SirGibihm))
  86. - Dragan Espenschied ([@despens](https://github.com/despens))
  87. - Elijah Zobenko ([@he110](https://github.com/he110))
  88. - Ernie ([@iamernie](https://github.com/iamernie))
  89. - Florian Moss ([@florianmoss](https://github.com/florianmoss))
  90. - Kelly Wardrop ([@dropcoded](https://github.com/dropcoded))
  91. - Loki ([@binaryloki](https://github.com/binaryloki))
  92. - Mattias Johnson ([@mattiasJohnson](https://github.com/mattiasJohnson))
  93. - Mitchell Rowton ([@mrowton](https://github.com/mrowton))
  94. - M. Scott Ford ([@mscottford](https://github.com/mscottford))
  95. - Nina Reynolds ([@cutecycle](https://github.com/cutecycle))
  96. - Noel Cower ([@nilium](https://github.com/nilium))
  97. - Robert Lanzke ([@winkelement](https://github.com/winkelement))
  98. - Sam Martin ([@winkelement](https://github.com/ABitMoreDepth))
  99. - aniketpanjwani ([@aniketpanjwani](https://github.com/aniketpanjwani))
  100. - aytaa ([@aytaa](https://github.com/aytaa))
  101. - magicpotato ([@fortheday](https://github.com/fortheday))
  102. - valantien ([@valantien](https://github.com/valantien))
  103. <h2 align="center">OpenCollective Sponsors</h2>
  104. Support this project by becoming a sponsor. Your logo will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [[Become a sponsor](https://opencollective.com/wikijs#sponsor)]
  105. <div align="center">
  106. <table>
  107. <tbody>
  108. <tr>
  109. <td align="center" valign="middle" width="192">
  110. <a href="https://opencollective.com/wikijs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/0/avatar.svg"></a>
  111. </td>
  112. <td align="center" valign="middle" width="192">
  113. <a href="https://opencollective.com/wikijs/sponsor/1/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/1/avatar.svg"></a>
  114. </td>
  115. <td align="center" valign="middle" width="192">
  116. <a href="https://opencollective.com/wikijs/sponsor/2/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/2/avatar.svg"></a>
  117. </td>
  118. <td align="center" valign="middle" width="192">
  119. <a href="https://opencollective.com/wikijs/sponsor/3/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/3/avatar.svg"></a>
  120. </td>
  121. </tr>
  122. <tr>
  123. <td align="center" valign="middle" width="192">
  124. <a href="https://opencollective.com/wikijs/sponsor/4/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/4/avatar.svg"></a>
  125. </td>
  126. <td align="center" valign="middle" width="192">
  127. <a href="https://opencollective.com/wikijs/sponsor/5/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/5/avatar.svg"></a>
  128. </td>
  129. <td align="center" valign="middle" width="192">
  130. <a href="https://opencollective.com/wikijs/sponsor/6/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/6/avatar.svg"></a>
  131. </td>
  132. <td align="center" valign="middle" width="192">
  133. <a href="https://opencollective.com/wikijs/sponsor/7/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/7/avatar.svg"></a>
  134. </td>
  135. </tr>
  136. <tr>
  137. <td align="center" valign="middle" width="192">
  138. <a href="https://opencollective.com/wikijs/sponsor/8/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/8/avatar.svg"></a>
  139. </td>
  140. <td align="center" valign="middle" width="192">
  141. <a href="https://opencollective.com/wikijs/sponsor/9/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/9/avatar.svg"></a>
  142. </td>
  143. <td align="center" valign="middle" width="192">
  144. <a href="https://opencollective.com/wikijs/sponsor/10/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/10/avatar.svg"></a>
  145. </td>
  146. <td align="center" valign="middle" width="192">
  147. <a href="https://opencollective.com/wikijs/sponsor/11/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/11/avatar.svg"></a>
  148. </td>
  149. </tr>
  150. <tr>
  151. <td align="center" valign="middle" width="192">
  152. <a href="https://opencollective.com/wikijs/sponsor/12/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/12/avatar.svg"></a>
  153. </td>
  154. <td align="center" valign="middle" width="192">
  155. <a href="https://opencollective.com/wikijs/sponsor/13/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/13/avatar.svg"></a>
  156. </td>
  157. <td align="center" valign="middle" width="192">
  158. <a href="https://opencollective.com/wikijs/sponsor/14/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/14/avatar.svg"></a>
  159. </td>
  160. <td align="center" valign="middle" width="192">
  161. <a href="https://opencollective.com/wikijs/sponsor/15/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/15/avatar.svg"></a>
  162. </td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. </div>
  167. <h2 align="center">Patreon Backers</h2>
  168. Thank you to all our patrons! 🙏 [[Become a patron](https://www.patreon.com/requarks)]
  169. <!--5 start-->
  170. - Al Romano
  171. - Alex Balabanov
  172. - Alex Zen
  173. - Arti Zirk
  174. - Brandon Curtis
  175. - djagoo
  176. - Douglas Lassance
  177. - Ernie Reid
  178. - Etienne
  179. - Flemis Jurgenheimer
  180. - Günter Pavlas
  181. - Ian
  182. - Iskander Callos
  183. - Josh Stewart
  184. - Loïc CRAMPON
  185. - Ludgeir Ibanez
  186. - Matt Gedigian
  187. - Philipp Schürch
  188. - Richeir
  189. - SmartNET.works
  190. - Stepan Sokolovskyi
  191. - 张白驹
  192. <!--5 end-->
  193. <h2 align="center">OpenCollective Backers</h2>
  194. Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/wikijs#backer)]
  195. <a href="https://opencollective.com/wikijs#backers" target="_blank"><img src="https://opencollective.com/wikijs/backers.svg?width=890"></a>
  196. <h2 align="center">Contributors</h2>
  197. This project exists thanks to all the people who contribute. [[Contribute]](https://github.com/Requarks/wiki/blob/master/.github/CONTRIBUTING.md).
  198. <a href="https://github.com/Requarks/wiki/graphs/contributors"><img src="https://opencollective.com/wikijs/contributors.svg?width=890" /></a>
  199. <h2 align="center">Special Thanks</h2>
  200. ![Algolia](https://wiki.js.org/legacy/logo_algolia.png)
  201. [Algolia](https://www.algolia.com/) for providing access to their incredible search engine.
  202. ![Browserstack](https://wiki.js.org/legacy/logo_browserstack.png)
  203. [Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.
  204. ![Bugsnag](https://wiki.js.org/legacy/logo-bugsnag.png)
  205. [Bugsnag](https://www.bugsnag.com/) for providing error monitoring solutions.
  206. ![Cloudflare](https://wiki.js.org/legacy/logo_cloudflare.png)
  207. [Cloudflare](https://www.cloudflare.com/) for providing their great CDN, SSL and advanced networking services.
  208. ![DigitalOcean](https://wiki.js.org/legacy/logo_digitalocean.png)
  209. [DigitalOcean](https://m.do.co/c/5f7445bfa4d0) for providing hosting of the Wiki.js documentation site.
  210. ![Icons8](https://static.requarks.io/logo/icons8.svg)
  211. [Icons8](https://icons8.com/) for providing beautiful icon sets.
  212. ![Netlify](https://wiki.js.org/legacy/logo_netlify.png)
  213. [Netlify](https://www.netlify.com) for providing hosting for landings and blog websites.