| .build | ||
| .github | ||
| .vscode | ||
| assets | ||
| client | ||
| npm | ||
| server | ||
| test | ||
| .babelrc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| .pug-lintrc.json | ||
| .snyk | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| 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 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
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
- 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
- Color Themes
- History
- Server-side TeX/MathML rendering
- Render linebreaks by default (Github style)
- New Localization: German
Beta 14
Planned for August release
- Revert to previous version (history)
- 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!
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
- Chinese - Thanks to @choicky
- French
- German - Thanks to @joetjengerdes
- Korean - Thanks to @junwonpk
- Portuguese - Thanks to @felipeplets
- 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.