Wiki.js | A modern and powerful wiki app built on Node.js
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
NGPixel 5cf775d7ec
docs: Updated README.md
8 years ago
.build feat: History page - List previous commits 8 years ago
.github docs: Updated issue template 8 years ago
.vscode Work on All Pages section 8 years ago
assets feat: Updated favicons to match new logo 8 years ago
client chore: Excluded docker branch from Travis build 8 years ago
npm chore: Updated npm package version 8 years ago
server feat: French localization 8 years ago
test refactor: moved server content to /server 8 years ago
.babelrc Base Project Files 8 years ago
.editorconfig User delete feature 8 years ago
.eslintignore Migrated to Fusebox 8 years ago
.eslintrc.json refactor: moved server content to /server 8 years ago
.gitattributes Base Project Files 8 years ago
.gitignore fix: Remove invalid yarn entry in gitignore 8 years ago
.pug-lintrc.json Fixed pug linting issues 8 years ago
.snyk Updated deps + versions 8 years ago
.travis.yml chore: Excluded docker branch from Travis build 8 years ago
CHANGELOG.md docs: Updated changelog + readme 8 years ago
Dockerfile fix: docker detection on install 8 years ago
LICENSE Initial commit 8 years ago
README.md docs: Updated README.md 8 years ago
config.docker.yml fix: Fixed i18n incorrect paths 8 years ago
config.sample.yml fix: Fixed i18n incorrect paths 8 years ago
docker-compose.yml fix: Removed duplicate pkg + Dockerfile (alpha) 8 years ago
fuse.js refactor: moved server content to /server 8 years ago
package.json fix: Empty anchors no longer crash the rendering process 8 years ago
wiki.cmd npm install feature 8 years ago
wiki.js refactor: moved server content to /server 8 years ago
yarn.lock fix: Empty anchors no longer crash the rendering process 8 years ago

README.md

Wiki.js

Release License npm Downloads Chat on Gitter Twitter Follow
Build Status Codefresh Build Status Codacy Badge Dependency Status Known Vulnerabilities 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 4.6.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.

Milestones

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

Beta 11

  • Azure AD authentication
  • MathML / Tex math equations
  • Support for CJK (Chinese, Japanese & Korean) characters in content, meta and uploads
  • All Pages section

Beta 12

  • Docker support + Auto compile/publish to Docker Hub
  • Heroku support

Beta 13

  • Insert Link modal in Editor
  • Better localization in the UI
  • 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:

  • English
  • French
  • Chinese - Thanks to @choicky

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.