Wiki.js | A modern and powerful wiki app built on Node.js

Jean-Christophe Bohin fefd60a356 docs: link to Changelog (#770) преди 6 години
.github 8b65a0873f misc: delete main.workflow преди 6 години
.vscode cb84df7a53 feat: save page преди 7 години
client 7e458f98b4 feat: scheduler storage sync преди 6 години
dev 42ef4f5297 docs: remove redis from docker compose example (#760) преди 6 години
server 7e458f98b4 feat: scheduler storage sync преди 6 години
.babelrc ed7d3ab540 fix: setup issues + webpack improvements преди 7 години
.editorconfig 72253f9cb5 fix: root admin access deny bug + patreon link преди 6 години
.eslintignore 392cbe9388 refactor: dev optimizations + improvements преди 7 години
.eslintrc.yml 6227690c94 feat: webpack refactor преди 7 години
.gitattributes b035a68ca4 Base Project Files преди 9 години
.gitignore 830ddd9d2c fix: await page render to finish before resolving преди 6 години
.npmrc 7f955707b7 chore: updated dependencies преди 8 години
.nvmrc e3943439e5 fix: terser dependency incompatbility преди 6 години
BACKERS.md aa27554bc7 feat: storage schedule + status преди 6 години
CHANGELOG.md 040f840807 feat: graphql rate limiting directive преди 6 години
LICENSE 5bec7ff5c5 Initial commit преди 9 години
Makefile cd3f88bad0 refactor: removed redis + new scheduler engine преди 6 години
README.md fefd60a356 docs: link to Changelog (#770) преди 6 години
config.sample.yml cd3f88bad0 refactor: removed redis + new scheduler engine преди 6 години
package.json 7e458f98b4 feat: scheduler storage sync преди 6 години
wiki.js cd3f88bad0 refactor: removed redis + new scheduler engine преди 6 години
yarn.lock 7e458f98b4 feat: scheduler storage sync преди 6 години

README.md

Wiki.js [![Release](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat&maxAge=3600)](https://github.com/Requarks/wiki/releases) [![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat)](https://github.com/requarks/wiki/blob/master/LICENSE) [![Backers on Open Collective](https://opencollective.com/wikijs/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/wikijs/sponsors/badge.svg)](#sponsors) [![Downloads](https://img.shields.io/github/downloads/Requarks/wiki/total.svg?style=flat)](https://www.npmjs.com/package/wiki.js) [![Docker Pulls](https://img.shields.io/docker/pulls/requarks/wiki.svg)](https://hub.docker.com/r/requarks/wiki/) [![Build status](https://dev.azure.com/requarks/wiki/_apis/build/status/build)](https://dev.azure.com/requarks/wiki/_build/latest?definitionId=9) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/1d0217a315)](https://www.codacy.com/app/Requarks/wiki) [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Chat on Gitter](https://img.shields.io/badge/chat-on_gitter-CC2B5E.svg?style=flat&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAOCAMAAADUg/YpAAAABlBMVEUAAAD///%2Bl2Z/dAAAAAXRSTlMAQObYZgAAABVJREFUeAFjwAUYYTQByAAh0WicAAAFnwAYeB5bLwAAAABJRU5ErkJggg==)](https://gitter.im/Requarks/wiki) [![Twitter Follow](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat)](https://twitter.com/requarks) ##### A modern, lightweight and powerful wiki app built on NodeJS

:white_check_mark: STABLE v1.x version

This repository is for the 2.0 BETA of Wiki.js.
It is highly recommended to use the 1.x version until a stable version of 2.0 is released. An easy and quick upgrade path will be provided to migrate from 1.x to 2.0.

:point_right: Go to version 1.x instead :point_left:

Version 2.0 should NOT be used in production! Once again, please use 1.x for now!


:construction: UNSTABLE v2.0 BETA version

This version is for testing and development purposes only! It is not ready for production and is still missing critical features. You cannot migrate 1.x data at this time!

Donate

Wiki.js is an open source project that has been made possible due to the generous contributions by community backers. If you are interested in supporting this project, please consider becoming a patron or donating to our OpenCollective.

Become a Patron

Requirements

Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.) or using Docker!

  • Node.js 10.12 or later
  • One of the following supported database engines:
    • MySQL 5.7.8 or later
    • PostgreSQL 9.5 or later
    • MariaDB 10.2.7 or later
    • Microsoft SQL Server 2012 or later
    • SQLite 3.9 or later

Read the full prerequisites article for full details.

Docker

Docker is the recommended way to go! Simply use Docker image: requarks/wiki:beta

You can also use Docker Compose (see example) to run Wiki.js with all dependencies.

Demo

Check out our documentation site, it's running Wiki.js!

Milestones

:bookmark_tabs: See project board to keep track of current progress.

Gitter

Want to discuss features, ideas or issues? Join our gitter channel. We are very active and friendly!
Chat on Gitter

Twitter

Follow our Twitter feed to learn about upcoming updates and new releases!
Twitter Follow

T-Shirts Shop

Want to donate to this project but get something in return as well? Check out our amazing t-shirts for men, women and kids, as well as other goodies: Wiki.js Shop

Translations

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, contact us on our gitter channel and we'll provide you access to our translation tool, absolutely no coding required!

Special Thanks

Algolia
Algolia for providing access to their incredible search engine.

Browserstack
Browserstack for providing access to their great cross-browser testing tools.

Cloudflare
Cloudflare for providing their great CDN, SSL and advanced networking services.

DigitalOcean
DigitalOcean for providing hosting of the Wiki.js documentation site.

Sponsors

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]

Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute. [Contribute].