| .build | ||
| .github | ||
| .vscode | ||
| assets | ||
| client | ||
| npm | ||
| server | ||
| test | ||
| .babelrc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| .pug-lintrc.json | ||
| .snyk | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| config.docker.yml | ||
| config.sample.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| fuse.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| wiki.cmd | ||
| wiki.js | ||
| yarn.lock | ||
A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
- Official Website
- Documentation
- Requirements
- Change Log
- Feature Requests
- Milestones
- Chat with us
- Translations (We need your help!)
- Special Thanks
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
- Better localization in the UI
- History / Revert to previous version feature
- Docker support + Auto compile/publish to Docker Hub
- Heroku support
Beta 13
- 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!
Follow our Twitter feed to learn about upcoming updates and new releases!
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
- Russian - Thanks to @efimlosev
- Spanish - Thanks to @MatiasArriola
Special Thanks
Browserstack for providing access to their great cross-browser testing tools.
DigitalOcean for providing hosting of the Wiki.js documentation site.