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

NGPixel f4969701d3 docs: updated changelog 8 anos atrás
.build 3d9aa18c05 refactor: Pre-render TeX + MathML server-side to SVG 8 anos atrás
.github 57299dbabd docs: Updated issue template 8 anos atrás
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) 8 anos atrás
assets 5312f5320a feat: updated icons to Nucleo 8 anos atrás
client c51d26a02d fix: search results href siteRoot undefined 8 anos atrás
npm c51d26a02d fix: search results href siteRoot undefined 8 anos atrás
server 6d7709268f fix: infinite loop on termination signal 8 anos atrás
test 04bd5837f5 chore: remove snyk 8 anos atrás
.babelrc b035a68ca4 Base Project Files 9 anos atrás
.editorconfig c6853a0315 User delete feature 8 anos atrás
.eslintignore 5189ec3835 Migrated to Fusebox 8 anos atrás
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component 8 anos atrás
.gitattributes b035a68ca4 Base Project Files 9 anos atrás
.gitignore ebe288a5b2 refactor: lazy-load simplemde + minimal lodash 8 anos atrás
.npmrc 7291ec9562 fix: lock dependencies 8 anos atrás
.pug-lintrc.json 15e4341fed Fixed pug linting issues 8 anos atrás
.travis.yml 9d090ab392 fix: missing icons + updated versions 8 anos atrás
.yarnrc 7291ec9562 fix: lock dependencies 8 anos atrás
CHANGELOG.md f4969701d3 docs: updated changelog 8 anos atrás
Dockerfile 8a836719a2 fix: Docker fixes 8 anos atrás
LICENSE 5bec7ff5c5 Initial commit 9 anos atrás
README.md d5157a3e76 docs: Fixed terminology 8 anos atrás
config.sample.yml a96a7efd9d fix: Safari + iOS load bug 8 anos atrás
docker-compose.yml f31dccab5f fix: Docker fixes 8 anos atrás
fuse.js a96a7efd9d fix: Safari + iOS load bug 8 anos atrás
package.json c51d26a02d fix: search results href siteRoot undefined 8 anos atrás
tsconfig.json 3fa941ce19 refactor: Upgrade to Fusebox 2.0 8 anos atrás
wiki.cmd ab32c95233 npm install feature 8 anos atrás
wiki.js d4b73be1e7 refactor: moved server content to /server 8 anos atrás
yarn.lock 6f0898aa8f fix: re-generate yarn.lock 8 anos atrás

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):

Beta 13

Progress

  • Color Themes
  • Server-side TeX/MathML rendering
  • Render line breaks 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
  • 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.