138 lines
12 KiB
Markdown
138 lines
12 KiB
Markdown
<div align="center">
|
|
|
|
<img src="https://static.requarks.io/logo/wikijs-full.svg" alt="Wiki.js" width="600" />
|
|
|
|
[](https://github.com/Requarks/wiki/releases)
|
|
[](https://github.com/requarks/wiki/blob/master/LICENSE)
|
|
[](https://opencollective.com/wikijs)
|
|
[](https://github.com/Requarks/wiki/releases)
|
|
[](https://hub.docker.com/r/requarks/wiki/)
|
|
[](https://dev.azure.com/requarks/wiki/_build/latest?definitionId=9)
|
|
[](https://sonarcloud.io/dashboard?id=wiki)
|
|
[](https://sonarcloud.io/dashboard?id=wiki)
|
|
[](https://sonarcloud.io/dashboard?id=wiki)
|
|
[](http://standardjs.com/)
|
|
[](https://wiki.requarks.io/slack)
|
|
[](https://twitter.com/requarks)
|
|
[](https://wiki.js.org/newsletter)
|
|
|
|
##### A modern, lightweight and powerful wiki app built on NodeJS
|
|
|
|
</div>
|
|
|
|
- **[Official Website](https://wiki.js.org/)**
|
|
- **[Documentation](https://docs.requarks.io/)**
|
|
- [Requirements](https://docs.requarks.io/install/requirements)
|
|
- [Demo](#demo)
|
|
- [Change Log](https://docs.requarks.io/releases)
|
|
- [Feature Requests](https://wiki.js.org/feedback)
|
|
- [Chat with us on Slack](#slack)
|
|
- [Translations](#translations) *(We need your help!)*
|
|
- [Special Thanks](#special-thanks)
|
|
- [Contribute](#contributors)
|
|
|
|
<h2 align="center">Donate</h2>
|
|
|
|
<div align="center">
|
|
|
|
Wiki.js is an open source project that has been made possible due to the generous contributions by community [backers](https://github.com/Requarks/wiki/blob/master/BACKERS.md). 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`).
|
|
|
|
[](https://github.com/users/NGPixel/sponsorship)
|
|
[](https://www.patreon.com/requarks)
|
|
[](https://opencollective.com/wikijs)
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FLV5X255Z9CJU&source=url)
|
|
[](https://etherscan.io/address/0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5)
|
|
[](https://wikijs.threadless.com)
|
|
|
|
</div>
|
|
|
|
<h2 align="center">Docker</h2>
|
|
|
|
<div align="center">
|
|
|
|
Docker is the recommended way to go! Simply use Docker image: `requarks/wiki:2`
|
|
|
|
You can also use Docker Compose ([see example](https://github.com/Requarks/wiki/blob/master/dev/examples/docker-compose.yml)) to run Wiki.js with all dependencies.
|
|
|
|
</div>
|
|
|
|
<h2 align="center">Demo</h2>
|
|
|
|
<div align="center">
|
|
|
|
Check out our [documentation site](https://docs.requarks.io), it's running Wiki.js!
|
|
|
|
</div>
|
|
|
|
<h2 align="center">Slack</h2>
|
|
|
|
<div align="center">
|
|
|
|
Want to discuss features, ideas or issues? Join our [Slack channel](https://wiki.requarks.io/slack). We are very active and friendly!
|
|
|
|
[](https://wiki.requarks.io/slack)
|
|
|
|
</div>
|
|
|
|
<h2 align="center">Twitter</h2>
|
|
|
|
<div align="center">
|
|
|
|
Follow our Twitter feed to learn about upcoming updates and new releases!
|
|
[](https://twitter.com/requarks)
|
|
|
|
</div>
|
|
|
|
<h2 align="center">Translations</h2>
|
|
|
|
We are looking for translators to make Wiki.js UI available in as many languages as possible. If you would like to contribute to this project, [click here](https://lokalise.com/public/2994254859f751ea605a00.03473540/) to gain access to our translation tool, absolutely no coding required! Feel free to contact us on our [Slack channel](https://wiki.requarks.io/slack) if you have any questions.
|
|
|
|
<h2 align="center">Special Thanks</h2>
|
|
|
|
|
|
[Algolia](https://www.algolia.com/) for providing access to their incredible search engine.
|
|
|
|
|
|
[Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.
|
|
|
|
|
|
[Bugsnag](https://www.bugsnag.com/) for providing error monitoring solutions.
|
|
|
|
|
|
[Cloudflare](https://www.cloudflare.com/) for providing their great CDN, SSL and advanced networking services.
|
|
|
|
|
|
[DigitalOcean](https://m.do.co/c/5f7445bfa4d0) for providing hosting of the Wiki.js documentation site.
|
|
|
|
|
|
[Icons8](https://icons8.com/) for providing beautiful icon sets.
|
|
|
|
|
|
[Netlify](https://www.netlify.com) for providing hosting for landings and blog websites.
|
|
|
|
<h2 align="center">Sponsors</h2>
|
|
|
|
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)]
|
|
|
|
<a href="https://opencollective.com/wikijs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/1/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/2/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/3/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/4/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/5/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/6/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/7/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/8/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/wikijs/sponsor/9/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/9/avatar.svg"></a>
|
|
|
|
<h2 align="center">Backers</h2>
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/wikijs#backer)]
|
|
|
|
<a href="https://opencollective.com/wikijs#backers" target="_blank"><img src="https://opencollective.com/wikijs/backers.svg?width=890"></a>
|
|
|
|
<h2 align="center">Contributors</h2>
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute]](https://github.com/Requarks/wiki/blob/master/.github/CONTRIBUTING.md).
|
|
<a href="https://github.com/Requarks/wiki/graphs/contributors"><img src="https://opencollective.com/wikijs/contributors.svg?width=890" /></a>
|