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
Nicolas Giard c572a69a50
Update README.md
8 years ago
.vscode Work on All Pages section 8 years ago
app Added CJK support + MathJax display 8 years ago
assets Remove generated assets from git repo 8 years ago
client Work on All Pages section 8 years ago
controllers Work on All Pages section 8 years ago
libs Use env PORT if defined 8 years ago
locales Azure AD support + defaultReadAccess option + All Pages UI work 8 years ago
middlewares Merged core back into main project 8 years ago
models Work on All Pages section 8 years ago
npm Added support for Heroku + config wizard fixes 8 years ago
test Removing node v4 and v6 for Travis build 8 years ago
views Use env PORT if defined 8 years ago
.babelrc Base Project Files 8 years ago
.deployexclude Migrated to Fusebox 8 years ago
.editorconfig User delete feature 8 years ago
.eslintignore Migrated to Fusebox 8 years ago
.eslintrc.json Merged core back into main project 8 years ago
.gitattributes Base Project Files 8 years ago
.gitignore Mathjax init handling 8 years ago
.pug-lintrc.json Fixed pug linting issues 8 years ago
.snyk Updated deps + versions 8 years ago
.travis.yml Removed zip option durinb deploy 8 years ago
CHANGELOG.md Fixed search not working for guests in public mode 8 years ago
LICENSE Initial commit 8 years ago
README.md Update README.md 8 years ago
agent.js Merged core back into main project 8 years ago
config.sample.yml Added CJK support + MathJax display 8 years ago
configure.js Added support for Heroku + config wizard fixes 8 years ago
fuse.js Added support for Heroku + config wizard fixes 8 years ago
init.js Added support for Heroku + config wizard fixes 8 years ago
package.json correct github references in dependencies section 8 years ago
server.js Fix eslint errors 8 years ago
wiki.cmd npm install feature 8 years ago
wiki.js Added support for Heroku + config wizard fixes 8 years ago

README.md

Wiki.js

Wiki.js

Release License npm Downloads Chat on Gitter Twitter Follow
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
  • Heroku support

Beta 12

  • Insert Link modal in Editor
  • Better localization in the UI
  • Better simultaneous user editing handling
  • Preview changes directly from the editor, without saving

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

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.