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

Nicolas Giard afb6f7d686 feat: Added Dutch translations + fixes 8 éve
.build 3d9aa18c05 refactor: Pre-render TeX + MathML server-side to SVG 8 éve
.github 57299dbabd docs: Updated issue template 8 éve
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) 8 éve
assets 5312f5320a feat: updated icons to Nucleo 8 éve
client c51d26a02d fix: search results href siteRoot undefined 8 éve
npm 9848f600e9 fix: run yarn locally 8 éve
server afb6f7d686 feat: Added Dutch translations + fixes 8 éve
test 04bd5837f5 chore: remove snyk 8 éve
.babelrc b035a68ca4 Base Project Files 9 éve
.editorconfig c6853a0315 User delete feature 8 éve
.eslintignore 5189ec3835 Migrated to Fusebox 8 éve
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component 8 éve
.gitattributes b035a68ca4 Base Project Files 9 éve
.gitignore ebe288a5b2 refactor: lazy-load simplemde + minimal lodash 8 éve
.npmrc 7291ec9562 fix: lock dependencies 8 éve
.pug-lintrc.json 15e4341fed Fixed pug linting issues 8 éve
.travis.yml 9848f600e9 fix: run yarn locally 8 éve
.yarnrc 7291ec9562 fix: lock dependencies 8 éve
CHANGELOG.md 2aa9ffd197 docs: updated changelog 8 éve
Dockerfile 8a836719a2 fix: Docker fixes 8 éve
LICENSE 5bec7ff5c5 Initial commit 9 éve
README.md 78c875503c docs: updated milestones 8 éve
config.sample.yml a96a7efd9d fix: Safari + iOS load bug 8 éve
docker-compose.yml f31dccab5f fix: Docker fixes 8 éve
fuse.js 6a45e1ee51 fix: Safari/iOS const redefinition 8 éve
package.json 9848f600e9 fix: run yarn locally 8 éve
tsconfig.json 6a45e1ee51 fix: Safari/iOS const redefinition 8 éve
wiki.cmd ab32c95233 npm install feature 8 éve
wiki.js d4b73be1e7 refactor: moved server content to /server 8 éve
yarn.lock 6a45e1ee51 fix: Safari/iOS const redefinition 8 éve

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.1 - Stable

Progress

  • Bug fixes release

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.

  • 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

Future

  • User Groups + Better permissions management
  • 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.