Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/frappe/wiki

Free and Open Source Wiki built on top of Frappe
https://github.com/frappe/wiki

documentation frappe knowledge-base rich-text wiki

Last synced: about 1 month ago
JSON representation

Free and Open Source Wiki built on top of Frappe

Lists

README

        





logotype


---


Wiki App built on the Frappe Framework | Try on Frappe Cloud

\
[![Wiki](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/w2jgcb/master&style=flat&logo=cypress)](https://cloud.cypress.io/projects/w2jgcb/runs)
[![CI](https://github.com/frappe/wiki/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/frappe/wiki/actions/workflows/ci.yml)

## Introduction

Frappe Wiki is an Open Source [Wiki](https://en.wikipedia.org/wiki/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.

## Installation

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

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

> [!NOTE]
> Use `version-14` branch with Frappe Framework v14 and for v14+ use `master` branch.

## Features

1. Create Wiki Pages
2. Author content in Rich Text
3. Set-up Controlled Wiki Updates
5. Add attachments
6. Table of Contents
7. Caching
8. Custom Script Support via `Wiki Settings`

## Screenshots

### 1. Rendered Page
wiki-rendered

### 2. Edit Page
wiki-edit

#### License

MIT