You are viewing the documentation for Wiki.js 2.x. For the newer Wiki.js 3.x, go to docs.js.wiki instead.
¶ Getting Started
Wiki.js is quick and easy to install. You should be up and running in no time.
- Requirements Server and database prerequisites.
- Installation Guide Detailed installation instructions for all platforms.
¶ User Guide
- The Basics New to Wiki.js? Learn how to use it and create your first page.
- Folder Structure & Tags Learn how to categorize your pages for an easier browsing experience.
- Manage Pages How to create, edit and manage your pages.
- Using Editors Learn how to use the various editors.
- Using Assets How to upload and manage assets such as images and documents.
¶ Administration
Locales Display the wiki in a different language or enable multilingual capabilities.
User Groups Permissions and access rights.
Telemetry Help Wiki.js developers understand crashes by enabling anonymous telemetry.
Troubleshooting Solutions to common issues.
¶ Modules
Modules greatly expand the capabilities of your wiki.
Authentication Configure how users can login and register to your wiki.
Comments Add discussion capabilities to your wiki.
Editors Manage the various editors used to create content.
Rendering Configure how content is parsed and rendered into its readable form.
Search Engines Manage the search capabilities of your wiki.
Storage Backup or sync the content of your wiki with external storage services.
¶ Developers
Wiki.js is fully extensible for maximum customization.
Getting Started How to setup a dev environment for Wiki.js.
Modules Learn how to create a module.
Themes Learn how to create your own theme.
¶ Localization
¶ Contribute
Ask a Question We're here to help.
Report a Bug Help us squash those pesky bugs.
Suggest a New Feature We need your ideas!
Donate Make a small donation or become a sponsor of this wonderful project!
