Wiki.js | A modern and powerful wiki app built on Node.js
NGPixel
04b5c8627d
docs: Updated README
|
il y a 8 ans | |
|---|---|---|
| .build | il y a 8 ans | |
| .github | il y a 8 ans | |
| .vscode | il y a 8 ans | |
| assets | il y a 8 ans | |
| client | il y a 8 ans | |
| npm | il y a 8 ans | |
| server | il y a 8 ans | |
| test | il y a 8 ans | |
| .babelrc | il y a 9 ans | |
| .editorconfig | il y a 8 ans | |
| .eslintignore | il y a 8 ans | |
| .eslintrc.json | il y a 8 ans | |
| .gitattributes | il y a 9 ans | |
| .gitignore | il y a 8 ans | |
| .pug-lintrc.json | il y a 8 ans | |
| .snyk | il y a 8 ans | |
| .travis.yml | il y a 8 ans | |
| CHANGELOG.md | il y a 8 ans | |
| Dockerfile | il y a 8 ans | |
| LICENSE | il y a 9 ans | |
| README.md | il y a 8 ans | |
| config.sample.yml | il y a 8 ans | |
| docker-compose.yml | il y a 8 ans | |
| fuse.js | il y a 8 ans | |
| package.json | il y a 8 ans | |
| tsconfig.json | il y a 8 ans | |
| wiki.cmd | il y a 8 ans | |
| wiki.js | il y a 8 ans | |
| yarn.lock | il y a 8 ans |
README.md
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.
Milestones
Current and upcoming milestones (major features only, see the changelog for complete list of features and bug fixes):
Beta 12
Planned for early June release
- Better localization in the UI
- Heroku support
- Refactor of all client-side code to modular Vue components
Beta 13
Planned for July release
- History / Revert to previous version feature
- Docker support + Auto compile/publish to Docker Hub
Beta 14
- 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
- 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.