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

NGPixel 20a2e0e3ce feat: history browse diffs пре 8 година
.build 3d9aa18c05 refactor: Pre-render TeX + MathML server-side to SVG пре 8 година
.github 57299dbabd docs: Updated issue template пре 8 година
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) пре 8 година
assets 5312f5320a feat: updated icons to Nucleo пре 8 година
client 20a2e0e3ce feat: history browse diffs пре 8 година
npm 8a836719a2 fix: Docker fixes пре 8 година
server 20a2e0e3ce feat: history browse diffs пре 8 година
test d4b73be1e7 refactor: moved server content to /server пре 8 година
.babelrc b035a68ca4 Base Project Files пре 9 година
.editorconfig c6853a0315 User delete feature пре 8 година
.eslintignore 5189ec3835 Migrated to Fusebox пре 8 година
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component пре 8 година
.gitattributes b035a68ca4 Base Project Files пре 9 година
.gitignore ebe288a5b2 refactor: lazy-load simplemde + minimal lodash пре 8 година
.npmrc 7291ec9562 fix: lock dependencies пре 8 година
.pug-lintrc.json 15e4341fed Fixed pug linting issues пре 8 година
.snyk 046f0b9a71 fix: Updated dependencies + snyk пре 8 година
.travis.yml f2bcc378d5 chore: Excluded docker branch from Travis build пре 8 година
.yarnrc 7291ec9562 fix: lock dependencies пре 8 година
CHANGELOG.md 137fefefe0 docs: Updated changelog пре 8 година
Dockerfile 8a836719a2 fix: Docker fixes пре 8 година
LICENSE 5bec7ff5c5 Initial commit пре 9 година
README.md c94d41e76d docs: updated milestones пре 8 година
config.sample.yml 919afb46e2 feat: Optional linebreaks + mathjax processing пре 8 година
docker-compose.yml f31dccab5f fix: Docker fixes пре 8 година
fuse.js 43f9a10416 feat: History diff UI пре 8 година
package-lock.json 7291ec9562 fix: lock dependencies пре 8 година
package.json 168e2e875d chore: updated dependencies пре 8 година
tsconfig.json 3fa941ce19 refactor: Upgrade to Fusebox 2.0 пре 8 година
wiki.cmd ab32c95233 npm install feature пре 8 година
wiki.js d4b73be1e7 refactor: moved server content to /server пре 8 година
yarn.lock 168e2e875d chore: updated dependencies пре 8 година

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.