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

NGPixel 61fe3d3d8b feat: npm install execute OS specific install script vor 8 Jahren
.build ae2482d910 fix: updated wercker definition vor 8 Jahren
.github 57299dbabd docs: Updated issue template vor 8 Jahren
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) vor 8 Jahren
assets 5312f5320a feat: updated icons to Nucleo vor 8 Jahren
client c51d26a02d fix: search results href siteRoot undefined vor 8 Jahren
npm 61fe3d3d8b feat: npm install execute OS specific install script vor 8 Jahren
server e7b6001cf8 fix: public access always false if using env var string vor 8 Jahren
test 04bd5837f5 chore: remove snyk vor 8 Jahren
.babelrc b035a68ca4 Base Project Files vor 9 Jahren
.editorconfig c6853a0315 User delete feature vor 8 Jahren
.eslintignore 5189ec3835 Migrated to Fusebox vor 8 Jahren
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component vor 8 Jahren
.gitattributes b035a68ca4 Base Project Files vor 9 Jahren
.gitignore ebe288a5b2 refactor: lazy-load simplemde + minimal lodash vor 8 Jahren
.npmrc 7291ec9562 fix: lock dependencies vor 8 Jahren
.pug-lintrc.json 15e4341fed Fixed pug linting issues vor 8 Jahren
.travis.yml 4ffaaf40e1 fix: exclude node_modules from deps archive vor 8 Jahren
.yarnrc 7291ec9562 fix: lock dependencies vor 8 Jahren
CHANGELOG.md d71619ea30 docs: updated changelog + milestones version vor 8 Jahren
Dockerfile 8a836719a2 fix: Docker fixes vor 8 Jahren
LICENSE 5bec7ff5c5 Initial commit vor 9 Jahren
README.md a85669b45f docs: updated milestones vor 8 Jahren
config.sample.yml a96a7efd9d fix: Safari + iOS load bug vor 8 Jahren
docker-compose.yml f31dccab5f fix: Docker fixes vor 8 Jahren
fuse.js 6a45e1ee51 fix: Safari/iOS const redefinition vor 8 Jahren
package.json 23e0d473e9 chore: update package version vor 8 Jahren
tsconfig.json 6a45e1ee51 fix: Safari/iOS const redefinition vor 8 Jahren
wercker.yml eb99744564 fix: updated wercker build definition vor 8 Jahren
wiki.cmd ab32c95233 npm install feature vor 8 Jahren
wiki.js d4b73be1e7 refactor: moved server content to /server vor 8 Jahren
yarn.lock 6a45e1ee51 fix: Safari/iOS const redefinition vor 8 Jahren

README.md

Wiki.js

Release License npm Downloads Twitter Follow
Build Status Codacy Badge Dependency Status Standard - JavaScript Style Guide Chat on Gitter

A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown

Documentation

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 article for full details.

Cloud Install

Deploy to Heroku

Docker, Azure and more coming soon!

Milestones

Current and upcoming milestones (major features only, see the changelog for complete list of features and bug fixes):

1.0.0 - Beta 13

Progress

  • Color Themes
  • Server-side TeX/MathML rendering
  • Render line breaks by default (GitHub style)
  • New Localization: German

1.0.4 - Stable

Progress

  • Bug fixes release
  • New Localization: Dutch

2.0.0 - Dev

Progress

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
  • Migrate to PostgreSQL + Redis datastore
  • History / Revert to previous version
  • Optional Two-Steps Authentication (2FA)
  • 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
  • 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
  • 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. We are very active and friendly!

Twitter

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

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 and we'll provide you with the necessary tool to add translations, no coding required!

Languages that are already translated:

Special Thanks

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

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