{"id":13459195,"url":"https://github.com/frappe/wiki","last_synced_at":"2025-05-15T15:05:29.695Z","repository":{"id":38193494,"uuid":"298861997","full_name":"frappe/wiki","owner":"frappe","description":"Free and Open Source Wiki built on top of Frappe","archived":false,"fork":false,"pushed_at":"2025-03-28T17:27:46.000Z","size":2511,"stargazers_count":295,"open_issues_count":39,"forks_count":228,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-04-07T21:09:16.131Z","etag":null,"topics":["documentation","frappe","knowledge-base","rich-text","wiki"],"latest_commit_sha":null,"homepage":"https://frappe.io/wiki","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frappe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-26T17:08:27.000Z","updated_at":"2025-04-07T19:25:41.000Z","dependencies_parsed_at":"2023-12-10T09:23:22.809Z","dependency_job_id":"ddc71b53-9150-4813-9708-8defcf917285","html_url":"https://github.com/frappe/wiki","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frappe%2Fwiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frappe%2Fwiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frappe%2Fwiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frappe%2Fwiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frappe","download_url":"https://codeload.github.com/frappe/wiki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254364270,"owners_count":22058878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","frappe","knowledge-base","rich-text","wiki"],"created_at":"2024-07-31T09:01:09.809Z","updated_at":"2025-05-15T15:05:29.649Z","avatar_url":"https://github.com/frappe.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg width=\"80\" alt=\"wiki\" src=\"https://github.com/user-attachments/assets/4869d211-fae2-4e93-8275-de433556feb0\" /\u003e\n\u003ch1\u003eFrappe Wiki\u003c/h1\u003e\n\n**Open Source Documentation Tool**\n\n[![Wiki](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/w2jgcb/master\u0026style=flat\u0026logo=cypress)](https://cloud.cypress.io/projects/w2jgcb/runs)\n[![CI](https://github.com/frappe/wiki/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/frappe/wiki/actions/workflows/ci.yml)\n\n\u003cimg width=\"1582\" alt=\"Hero Image\" src=\"https://github.com/user-attachments/assets/b4bedd31-96fe-4c07-aded-339eade4a7d1\" /\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003ca href=\"https://frappe.io/wiki\"\u003eWebsite\u003c/a\u003e\n-\n\u003ca href=\"https://docs.frappe.io/wiki/\"\u003eDocumentation\u003c/a\u003e\n\u003c/div\u003e\n\n## Frappe Wiki\n\nFrappe 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.\n\n\u003cdetails\u003e\n\u003csummary\u003eScreenshots\u003c/summary\u003e\n\u003cimg width=\"1582\" alt=\"Screenshot 2025-01-13 at 2 13 54 PM\" src=\"https://github.com/user-attachments/assets/36120ff2-7dd4-4c29-ac02-131907ef381e\" /\u003e\n\u003c/details\u003e\n\n\n### Motivation\n\nFrappe 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!\n\nOur 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.\n\n\n### Key Features\n\n- **Create Wiki Pages**: Easily create and organize wiki pages to manage and share knowledge systematically.\nAuthor Content in Markdown: Write and format content effortlessly using Markdown syntax, ensuring a clean and readable structure.\n- **Set-up Controlled Wiki Updates**: Implement workflows to review and approve edits before publishing, ensuring content accuracy and consistency.\n- **Add Attachments**: Attach relevant files and documents directly to wiki pages for better context and resource sharing.\n- **Table of Contents**: Automatically generate a navigable table of contents for enhanced readability and structure.\n- **Custom Script Support via Wiki Settings**: Customize wiki behavior and extend functionality using custom scripts configured in Wiki Settings.\n\n### Under the Hood\n\n- [**Frappe Framework**](https://github.com/frappe/frappe): A full-stack web application framework.\n\n- [**Ace Editor**](https://github.com/ajaxorg/ace): Ace is an embeddable code editor written in JavaScript.\n\n- [**RedisSearch**](https://github.com/RediSearch/RediSearch): A powerful search and indexing engine built on top of Redis.\n\n## Production Setup\n\n### Managed Hosting\n\nYou 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.\n\nIt 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.\n\n\u003cdiv\u003e\n    \u003ca href=\"https://frappecloud.com/marketplace/apps/wiki\" target=\"_blank\"\u003e\n        \u003cpicture\u003e\n            \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://frappe.io/files/try-on-fc-white.png\"\u003e\n            \u003cimg src=\"https://frappe.io/files/try-on-fc-black.png\" alt=\"Try on Frappe Cloud\" height=\"28\" /\u003e\n        \u003c/picture\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n## Development Setup\n\n\n### Local\n\nTo setup the repository locally follow the steps mentioned below:\n\n1. Setup bench by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) and start the server\n\n```\nbench start\n```\n\n2. In a separate terminal window, cd into `frappe-bench` directory and run the following commands:\n\n```\n# get app\n$ bench get-app https://github.com/frappe/wiki\n\n# install on site\n$ bench --site sitename install-app wiki\n\n```\n\n## Learn and connect\n- [Telegram Public Group](https://t.me/frappewiki)\n- [Discuss Forum](https://discuss.frappe.io/c/wiki/72)\n- [Documentation](https://docs.frappe.io/wiki/)\n- [YouTube](https://www.youtube.com/@frappetech)\n\n\u003cbr\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\" style=\"padding-top: 0.75rem;\"\u003e\n    \u003ca href=\"https://frappe.io\" target=\"_blank\"\u003e\n        \u003cpicture\u003e\n            \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://frappe.io/files/Frappe-white.png\"\u003e\n            \u003cimg src=\"https://frappe.io/files/Frappe-black.png\" alt=\"Frappe Technologies\" height=\"28\"/\u003e\n        \u003c/picture\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n","funding_links":[],"categories":["Python","Uncategorized"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrappe%2Fwiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrappe%2Fwiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrappe%2Fwiki/lists"}