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

NGPixel 62ca6e55b3 fix: mathjax timeout + external link icons 8 lat temu
.build 3d9aa18c05 refactor: Pre-render TeX + MathML server-side to SVG 8 lat temu
.github 57299dbabd docs: Updated issue template 8 lat temu
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) 8 lat temu
assets 5312f5320a feat: updated icons to Nucleo 8 lat temu
client 62ca6e55b3 fix: mathjax timeout + external link icons 8 lat temu
npm 9d090ab392 fix: missing icons + updated versions 8 lat temu
server 62ca6e55b3 fix: mathjax timeout + external link icons 8 lat temu
test 04bd5837f5 chore: remove snyk 8 lat temu
.babelrc b035a68ca4 Base Project Files 9 lat temu
.editorconfig c6853a0315 User delete feature 8 lat temu
.eslintignore 5189ec3835 Migrated to Fusebox 8 lat temu
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component 8 lat temu
.gitattributes b035a68ca4 Base Project Files 9 lat temu
.gitignore ebe288a5b2 refactor: lazy-load simplemde + minimal lodash 8 lat temu
.npmrc 7291ec9562 fix: lock dependencies 8 lat temu
.pug-lintrc.json 15e4341fed Fixed pug linting issues 8 lat temu
.travis.yml 9d090ab392 fix: missing icons + updated versions 8 lat temu
.yarnrc 7291ec9562 fix: lock dependencies 8 lat temu
CHANGELOG.md 8ad17daa0e fix: alert icons 8 lat temu
Dockerfile 8a836719a2 fix: Docker fixes 8 lat temu
LICENSE 5bec7ff5c5 Initial commit 9 lat temu
README.md c94d41e76d docs: updated milestones 8 lat temu
config.sample.yml 9d090ab392 fix: missing icons + updated versions 8 lat temu
docker-compose.yml f31dccab5f fix: Docker fixes 8 lat temu
fuse.js 62ca6e55b3 fix: mathjax timeout + external link icons 8 lat temu
package.json 62ca6e55b3 fix: mathjax timeout + external link icons 8 lat temu
tsconfig.json 3fa941ce19 refactor: Upgrade to Fusebox 2.0 8 lat temu
wiki.cmd ab32c95233 npm install feature 8 lat temu
wiki.js d4b73be1e7 refactor: moved server content to /server 8 lat temu
yarn.lock 62ca6e55b3 fix: mathjax timeout + external link icons 8 lat temu

README.md

Wiki.js

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

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.9.0 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):

Beta 12

Progress

  • Anchor with Copy to clipboard function
  • Full UI Localization
  • Heroku support
  • New Localizations: Chinese, French, Korean, Portuguese, Russian and Spanish
  • Refactor of all client-side code to modular Vue components

Beta 13

Planned for July release
Progress

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

Beta 14

Planned for August release
Progress

  • History / Revert to previous version
  • Optional Two-Steps Authentication (2FA)
  • Docker support + Auto compile/publish to Docker Hub
  • User Groups + Better permissions management
  • Support sub-directory installations (e.g. example.com/wiki)

Future

  • Insert Link modal in Editor
  • Better simultaneous user editing handling
  • Preview changes directly from the editor, without saving
  • 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.