Go to file
2017-07-26 21:40:34 -04:00
.build fix: updated wercker definition 2017-07-23 21:50:50 -04:00
.github docs: Updated issue template 2017-04-24 22:47:16 -04:00
.vscode fix: Incorrect indentation (eslint) 2017-07-09 00:01:34 -04:00
assets feat: updated icons to Nucleo 2017-07-09 00:01:34 -04:00
client fix: search results href siteRoot undefined 2017-07-20 21:29:10 -04:00
npm fix: install deps from prebuilt package 2017-07-26 21:40:34 -04:00
server fix: updated wercker definition 2017-07-23 21:50:50 -04:00
test chore: remove snyk 2017-07-09 00:01:34 -04:00
.babelrc Base Project Files 2016-08-16 20:56:55 -04:00
.editorconfig User delete feature 2017-02-10 13:13:40 -05:00
.eslintignore Migrated to Fusebox 2017-03-26 22:07:40 -04:00
.eslintrc.json refactor: editor codeblock -> Vue component 2017-05-28 14:34:50 -04:00
.gitattributes Base Project Files 2016-08-16 20:56:55 -04:00
.gitignore refactor: lazy-load simplemde + minimal lodash 2017-05-27 22:24:46 -04:00
.npmrc fix: lock dependencies 2017-07-09 00:01:34 -04:00
.pug-lintrc.json Fixed pug linting issues 2017-02-09 21:35:37 -05:00
.travis.yml fix: run yarn locally 2017-07-23 13:48:56 -04:00
.yarnrc fix: lock dependencies 2017-07-09 00:01:34 -04:00
CHANGELOG.md docs: updated version 2017-07-23 16:42:45 -04:00
config.sample.yml fix: Safari + iOS load bug 2017-07-20 18:17:23 -04:00
docker-compose.yml fix: Docker fixes 2017-07-09 00:01:34 -04:00
Dockerfile fix: Docker fixes 2017-07-09 00:01:34 -04:00
fuse.js fix: Safari/iOS const redefinition 2017-07-22 10:33:31 -04:00
LICENSE Initial commit 2016-08-16 15:35:26 -04:00
package.json fix: install deps from prebuilt package 2017-07-26 21:40:34 -04:00
README.md docs: updated build badge 2017-07-23 16:57:13 -04:00
tsconfig.json fix: Safari/iOS const redefinition 2017-07-22 10:33:31 -04:00
wercker.yml fix: updated wercker build definition 2017-07-23 21:59:31 -04:00
wiki.cmd npm install feature 2017-02-14 15:27:08 -05:00
wiki.js refactor: moved server content to /server 2017-04-28 17:58:38 -04:00
yarn.lock fix: Safari/iOS const redefinition 2017-07-22 10:33:31 -04:00

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.3 - 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.