Wiki
Wiki is an open-source knowledge management application built on the Frappe Framework. It is designed for creating, organizing, and maintaining documentation, knowledge bases, SOPs, product manuals, and other text-heavy content.
Unlike traditional documentation systems that require deployments for every update, Wiki allows you to publish changes instantly, making it ideal for teams that frequently update their documentation.
Tip
Since Wiki is built on the Frappe Framework, it integrates naturally with other Frappe applications while remaining completely open source and customizable.
Why Use Wiki?
Wiki simplifies documentation management by providing a clean editing experience together with powerful organization and collaboration features.
With Wiki, you can:
- Use a fully open-source platform that you can customize to your requirements.
- Build on the scalable and reliable Frappe Framework.
- Maintain complete ownership of your data without vendor lock-in.
Key Features
Wiki provides everything needed to build and maintain documentation efficiently.
- Create and manage documentation pages.
- Organize content into separate Wiki Spaces.
- Control content publishing with approval workflows.
- Attach files and supporting documents to pages.
- Generate a table of contents automatically.
- Maintain complete version history for every page.
- Write content using Markdown.
- Serve pages quickly using built-in caching.
- Add custom scripts through Wiki Settings.
- Customize the sidebar using drag-and-drop.
Built on the Frappe Framework
Wiki is powered by the Frappe Framework, a full-stack web application framework written in Python and JavaScript.
The framework provides features such as:
- Database abstraction layer
- User authentication and role management
- REST APIs
- Background jobs and scheduling
- Built-in permissions and security
Installation
To install Wiki on your Frappe Bench, follow the official installation guide available in the project’s repository.
Community Resources
Wiki has an active open-source community where you can contribute, ask questions, and stay updated.
- GitHub — Browse the source code, report issues, and contribute to development.
- Telegram Community — Get help and discuss Wiki with other users.
- Discussion Forum — Participate in feature discussions and community support.
Related Topics
- Wiki Spaces
- Wiki Pages
- Markdown Editor
- Version History
- Approval Workflow
- Attachments
Best Practices
- Organize documentation into dedicated Wiki Spaces for easier navigation.
- Use descriptive page titles to improve searchability.
- Review version history before restoring previous revisions.
- Use approval workflows for documentation that requires review.
- Keep the sidebar organized so frequently accessed pages are easy to find.