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

NGPixel 61fe3d3d8b feat: npm install execute OS specific install script há 8 anos atrás
.build ae2482d910 fix: updated wercker definition há 8 anos atrás
.github 57299dbabd docs: Updated issue template há 8 anos atrás
.vscode a1b6dfb308 fix: Incorrect indentation (eslint) há 8 anos atrás
assets 5312f5320a feat: updated icons to Nucleo há 8 anos atrás
client c51d26a02d fix: search results href siteRoot undefined há 8 anos atrás
npm 61fe3d3d8b feat: npm install execute OS specific install script há 8 anos atrás
server e7b6001cf8 fix: public access always false if using env var string há 8 anos atrás
test 04bd5837f5 chore: remove snyk há 8 anos atrás
.babelrc b035a68ca4 Base Project Files há 9 anos atrás
.editorconfig c6853a0315 User delete feature há 8 anos atrás
.eslintignore 5189ec3835 Migrated to Fusebox há 8 anos atrás
.eslintrc.json f577a8134e refactor: editor codeblock -> Vue component há 8 anos atrás
.gitattributes b035a68ca4 Base Project Files há 9 anos atrás
.gitignore ebe288a5b2 refactor: lazy-load simplemde + minimal lodash há 8 anos atrás
.npmrc 7291ec9562 fix: lock dependencies há 8 anos atrás
.pug-lintrc.json 15e4341fed Fixed pug linting issues há 8 anos atrás
.travis.yml 4ffaaf40e1 fix: exclude node_modules from deps archive há 8 anos atrás
.yarnrc 7291ec9562 fix: lock dependencies há 8 anos atrás
CHANGELOG.md d71619ea30 docs: updated changelog + milestones version há 8 anos atrás
Dockerfile 8a836719a2 fix: Docker fixes há 8 anos atrás
LICENSE 5bec7ff5c5 Initial commit há 9 anos atrás
README.md a85669b45f docs: updated milestones há 8 anos atrás
config.sample.yml a96a7efd9d fix: Safari + iOS load bug há 8 anos atrás
docker-compose.yml f31dccab5f fix: Docker fixes há 8 anos atrás
fuse.js 6a45e1ee51 fix: Safari/iOS const redefinition há 8 anos atrás
package.json 23e0d473e9 chore: update package version há 8 anos atrás
tsconfig.json 6a45e1ee51 fix: Safari/iOS const redefinition há 8 anos atrás
wercker.yml eb99744564 fix: updated wercker build definition há 8 anos atrás
wiki.cmd ab32c95233 npm install feature há 8 anos atrás
wiki.js d4b73be1e7 refactor: moved server content to /server há 8 anos atrás
yarn.lock 6a45e1ee51 fix: Safari/iOS const redefinition há 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):

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.4 - Stable

Progress

  • Bug fixes release
  • New Localization: Dutch

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.

  • GraphQL API
  • 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
  • User Groups + Better permissions management
  • Make use of all available CPU cores, distributed jobs queue
  • Tags per document / folder
  • Comments / Discussion per document
  • Profile page per user
  • Preview changes directly from the editor, without saving
  • Modular authentication providers
  • High Availability support (multiple concurrent instances)

Future

  • Insert Link modal in Editor
  • Better simultaneous user editing handling
  • 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.