From b9bfec6eb01deed32d5174841663778d93080a5a Mon Sep 17 00:00:00 2001 From: Aysha <74527579+AyshaHakeem@users.noreply.github.com> Date: Thu, 26 Dec 2024 11:09:44 +0530 Subject: [PATCH] Update README.md --- README.md | 131 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 92 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index b89c224f..3d886328 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,110 @@ -
-
-
-logotype -
-
+wiki +

Frappe Wiki

---- +**Open Source Documentation Tool** -
- 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) +[![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) + +Hero Image + +
+
+Website +- +Documentation
-## Introduction +## Frappe Wiki -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. +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. -## Installation +
+Screenshots +EditvPage +
-```bash -# get app -$ bench get-app https://github.com/frappe/wiki -# install on site -$ bench --site sitename install-app wiki -``` +### 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 -> [!NOTE] -> Use `version-14` branch with Frappe Framework v14 and for v14+ use `master` branch. +- **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. -## Features +### Under the Hood -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` +- [**Frappe Framework**](https://github.com/frappe/frappe): A full-stack web application framework. -## Screenshots +- [**Ace Editor**](https://github.com/ajaxorg/ace): Ace is an embeddable code editor written in JavaScript. -### 1. Rendered Page -wiki-rendered +- [**RedisSearch**](https://github.com/RediSearch/RediSearch): A powerful search and indexing engine built on top of Redis. -### 2. Edit Page -wiki-edit +## 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. + +
+ + + + Try on Frappe Cloud + + +
-#### License +## Development Setup -MIT + +### 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) + +
+
+
+ + + + Frappe Technologies + + +