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: 2 days ago
JSON representation
Free and Open Source Wiki built on top of Frappe
- Host: GitHub
- URL: https://github.com/frappe/wiki
- Owner: frappe
- License: mit
- Created: 2020-09-26T17:08:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T06:37:26.000Z (12 days ago)
- Last Synced: 2025-01-12T13:04:11.821Z (9 days ago)
- Topics: documentation, frappe, knowledge-base, rich-text, wiki
- Language: Python
- Homepage: https://frappe.io/wiki
- Size: 2.25 MB
- Stars: 256
- Watchers: 25
- Forks: 206
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - frappe/wiki - Free and Open Source Wiki built on top of Frappe (Python)
- awesome-frappe - Wiki - Wiki for serving dynamic data along with a built-in review system. (Uncategorized / Uncategorized)
README
Frappe Wiki
**Open Source Documentation Tool**
[](https://cloud.cypress.io/projects/w2jgcb/runs)
[](https://github.com/frappe/wiki/actions/workflows/ci.yml)
## 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**](https://github.com/frappe/frappe): A full-stack web application framework.
- [**Ace Editor**](https://github.com/ajaxorg/ace): Ace is an embeddable code editor written in JavaScript.
- [**RedisSearch**](https://github.com/RediSearch/RediSearch): A powerful search and indexing engine built on top of Redis.
## Production Setup
### Managed Hosting
You can try [Frappe Cloud](https://frappecloud.com), a simple, user-friendly and sophisticated [open-source](https://github.com/frappe/press) 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](https://frappeframework.com/docs/user/en/installation) 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](https://t.me/frappewiki)
- [Discuss Forum](https://discuss.frappe.io/c/wiki/72)
- [Documentation](https://docs.frappe.io/wiki/)
- [YouTube](https://www.youtube.com/@frappetech)
