Frappe Wiki

Open Source Documentation Tool

Website - Documentation

Frappe Wiki

Frappe Wiki is an Open Source Wiki app built on the Frappe Framework. It is well suited to serve dynamic, text-heavy content like documentation and knowledge base. It allows publishing small changes and even new pages on the fly without downtime. It also maintains revision history and has a change approval mechanism.

Screenshots

Motivation

Frappe Wiki, like many of our products was developed for our own needs. We were looking for a simple, clean, open source wiki to write documentation for ERPNext, but due to a lack of good options, we decided to write our own from scratch!

Our goal was clear: create an open-source wiki that provides a delightful experience for writers and readers. Today, we use Frappe Wiki for all sorts of internal things – user manuals, company policies, you name it! The easy-to-use interface and simple editing features make it perfect for anyone on our team.

Key Features

• Create Wiki Pages: Easily create and organize wiki pages to manage and share knowledge systematically. Author Content in Markdown: Write and format content effortlessly using Markdown syntax, ensuring a clean and readable structure.
• Set-up Controlled Wiki Updates: Implement workflows to review and approve edits before publishing, ensuring content accuracy and consistency.
• Add Attachments: Attach relevant files and documents directly to wiki pages for better context and resource sharing.
• Table of Contents: Automatically generate a navigable table of contents for enhanced readability and structure.
• Custom Script Support via Wiki Settings: Customize wiki behavior and extend functionality using custom scripts configured in Wiki Settings.

Under the Hood

• Frappe Framework: A full-stack web application framework.

• Ace Editor: Ace is an embeddable code editor written in JavaScript.

• RedisSearch: A powerful search and indexing engine built on top of Redis.

Production Setup

Managed Hosting

You can try Frappe Cloud, a simple, user-friendly and sophisticated open-source platform to host Frappe applications with peace of mind.

It takes care of installation, setup, upgrades, monitoring, maintenance and support of your Frappe deployments. It is a fully featured developer platform with an ability to manage and control multiple Frappe deployments.

Development Setup

Local

To setup the repository locally follow the steps mentioned below:

1. Setup bench by following the Installation Steps and start the server

bench start

2. In a separate terminal window, cd into frappe-bench directory and run the following commands:

# get app
$ bench get-app https://github.com/frappe/wiki

# install on site
$ bench --site sitename install-app wiki

Learn and connect

• Telegram Public Group
• Discuss Forum
• Documentation
• YouTube