Skip to content
Back to search

wiki

Free and Open Source Wiki built on top of Frappe

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/frappe/wiki with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/frappe/wiki'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/frappe--wiki/badge.svg)](/listings/frappe--wiki)

HTML

<a href="/listings/frappe--wiki"><img src="/api/listings/frappe--wiki/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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.

<div> <a href="https://frappecloud.com/marketplace/apps/wiki" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png"> </picture> </a> </div>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 231 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. <img width="80" alt="Frappe Wiki" src="wiki/public/images/frappe-wiki-logo.svg" />
  3. <h1>Frappe Wiki</h1>
  4. **Open Source Documentation Tool**
  5. [![CI](https://github.com/frappe/wiki/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/frappe/wiki/actions/workflows/ci.yml)
  6. [![UI Tests](https://github.com/frappe/wiki/actions/workflows/ui-tests.yml/badge.svg?event=push)](https://github.com/frappe/wiki/actions/workflows/ui-tests.yml)
  7. <picture>
  8. <source media="(prefers-color-scheme: dark)" srcset="docs/images/introduction/overview-dark.webp">
  9. <img width="1582" alt="The Company Handbook in Frappe Wiki, open on a page with the page tree, a timeline diagram and the table of contents" src="docs/images/introduction/overview-light.webp">
  10. </picture>
  11. <br />
  12. <br />
  13. <a href="https://frappe.io/wiki">Website</a>
  14. -
  15. <a href="docs/introduction/what-is-frappe-wiki.md">Documentation</a>
  16. </div>
  17. ## Frappe Wiki
  18. Frappe Wiki is an open-source wiki app on the Frappe Framework. Use it for product guides, help centers, company handbooks and team notes. Writers work in a rich text editor. Each change goes through review before it goes live, and the wiki keeps the history of every page. Readers get fast, clean pages with search and light and dark mode.
  19. - [Motivation](#motivation)
  20. - [Key features](#key-features)
  21. - [Under the hood](#under-the-hood)
  22. - [Compatibility](#compatibility)
  23. - [Production setup](#production-setup)
  24. - [Development setup](#development-setup)
  25. - [Learn and connect](#learn-and-connect)
  26. ### Motivation
  27. Frappe Wiki, like many of our products, started from our own needs. We wanted a simple, clean, open-source wiki for the ERPNext documentation, and we did not find a good one. So we wrote our own.
  28. Our goal was clear: an open-source wiki that writers and readers enjoy. Today we use Frappe Wiki for many things, such as user manuals and company policies. The interface is simple, so anyone on the team can write.
  29. ### Key features
  30. - **Spaces.** A space holds the pages of one wiki, such as a product guide or a handbook. Each space has its own URL, logo and access rules. A space can be public, or private to some roles.
  31. - **A rich text editor.** Write with headings, tables, task lists, code blocks, callouts, images, Mermaid diagrams, PDFs and videos. Content is stored as Markdown. An image can have a dark-mode version.
  32. - **Change requests.** Your edits collect in a change request, like a branch. A reviewer reads the diff, then approves, asks for changes or rejects it. When it is merged, the change goes live. Readers can also propose changes.
  33. - **A fast reader.** Published pages have a page tree, a table of contents, search, light and dark mode, and PDF download. Readers can give feedback on each page.
  34. - **Analytics.** See page views, new visitors, top pages and referrers for the whole wiki, a space or one page.
  35. - **GitHub Sync.** Keep a space in step with a folder of Markdown files in a GitHub repository. Preview the folder on your development site before you push.
  36. - **SEO and AI readiness.** Each page has meta tags and a generated social card. The wiki serves a sitemap, a Markdown copy of each page and an `llms.txt` index. A skill lets AI coding agents draft pages through change requests.
  37. <details>
  38. <summary><b>Write</b>: the editor with the page tree, the toolbar and the page</summary>
  39. <br>
  40. <picture>
  41. <source media="(prefers-color-scheme: dark)" srcset="docs/images/authoring-content/editor-layout-dark.webp">
  42. <img alt="The editor, with the page tree on the left and the page in the middle" src="docs/images/authoring-content/editor-layout-light.webp">
  43. </picture>
  44. </details>
  45. <details>
  46. <summary><b>Review</b>: a change request with the changes side by side</summary>
  47. <br>
  48. <picture>
  49. <source media="(prefers-color-scheme: dark)" srcset="docs/images/change-requests/review-side-by-side-dark.webp">
  50. <img alt="A change request in review, with the old and the new version of a page side by side" src="docs/images/change-requests/review-side-by-side-light.webp">
  51. </picture>
  52. </details>
  53. <details>
  54. <summary><b>Read</b>: a published page with the page tree and the table of contents</summary>
  55. <br>
  56. <picture>
  57. <source media="(prefers-color-scheme: dark)" srcset="docs/images/introduction/reader-dark.webp">
  58. <img alt="A published page, with the page tree, the page and On this page" src="docs/images/introduction/reader-light.webp">
  59. </picture>
  60. </details>
  61. <details>
  62. <summary><b>Measure</b>: page views, top pages and referrers</summary>
  63. <br>
  64. <picture>
  65. <source media="(prefers-color-scheme: dark)" srcset="docs/images/analytics/overview-dark.webp">
  66. <img alt="The Overview page, with page views, new visitors, views by space, top pages and top referrers" src="docs/images/analytics/overview-light.webp">
  67. </picture>
  68. </details>
  69. <details>
  70. <summary><b>Sync</b>: a space that GitHub Sync keeps up to date</summary>
  71. <br>
  72. <picture>
  73. <source media="(prefers-color-scheme: dark)" srcset="docs/images/github-sync/git-sync-panel-dark.webp">
  74. <img alt="The Git Sync tab of a space, with the repository, the webhook URL and the sync history" src="docs/images/github-sync/git-sync-panel-light.webp">
  75. </picture>
  76. </details>
  77. <details>
  78. <summary><b>Share with AI</b>: copy a page as Markdown, or open it in ChatGPT or Claude</summary>
  79. <br>
  80. <picture>
  81. <source media="(prefers-color-scheme: dark)" srcset="docs/images/introduction/reader-ai-menu-dark.webp">
  82. <img alt="The page menu of a published page, with Copy page as Markdown, Open in ChatGPT and Open in Claude" src="docs/images/introduction/reader-ai-menu-light.webp">
  83. </picture>
  84. </details>
  85. ### Under the hood
  86. - [**Frappe Framework**](https://github.com/frappe/frappe): a full-stack web application framework. It gives the wiki its users, roles, database and API.
  87. - [**Frappe UI**](https://github.com/frappe/frappe-ui): a Vue component library. The wiki app at `/wiki-app` uses it.
  88. - [**Tiptap**](https://github.com/ueberdosis/tiptap): the editor framework. Pages are stored as Markdown.
  89. - [**SQLite**](https://www.sqlite.org/fts5.html): full-text search for the pages.
  90. - [**DuckDB**](https://github.com/duckdb/duckdb): fast counts for the page view analytics.
  91. ### Compatibility
  92. This app is compatible with the following versions of Frappe:
  93. | Wiki branch | Stability | Frappe branch |
  94. | :---------------- | :-------- | :------------ |
  95. | master - v2.x | stable | v15.x |
  96. | version-3 - v3.x | stable | v15.x & v16.x |
  97. | develop - nightly | unstable | develop |
  98. On Frappe develop, Wiki also runs on SQLite (`bench new-site --db-type sqlite`). Frappe still marks SQLite support as experimental.
  99. <details>
  100. <summary><b>Older, unsupported versions</b></summary>
  101. <br>
  102. | Wiki branch | Frappe branch |
  103. | :---------- | :------------ |
  104. | version-14 | v14.x |
  105. | version-13 | v13.x |
  106. Frappe and Wiki do not support these versions. These branches do not get fixes, and we do not accept contributions to them.
  107. </details>
  108. ## Production setup
  109. ### Managed hosting
  110. 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.
  111. It does the installation, setup, upgrades, monitoring, maintenance and support of your Frappe deployments. It is a full developer platform that lets you manage many Frappe deployments.
  112. <div>
  113. <a href="https://frappecloud.com/marketplace/apps/wiki" target="_blank">
  114. <picture>
  115. <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png">
  116. <img src="https://frappe.io/files/try-on-fc-black.png" alt="Try on Frappe Cloud" height="28" />
  117. </picture>
  118. </a>
  119. </div>
  120. ### Self-hosting
  121. Use [Frappe Pilot](https://github.com/frappe/pilot#readme) to host Frappe Wiki on your own server. Pilot installs and manages benches and sites, and sets up production for you.
  122. 1. Install Pilot and create a bench. Follow the steps in the [Pilot README](https://github.com/frappe/pilot#readme).
  123. 2. Get the app, create a site and install the app on it:
  124. ```sh
  125. pilot -b <bench> get-app https://github.com/frappe/wiki --branch version-3
  126. pilot -b <bench> new-site <site>
  127. pilot -b <bench> install-app <site> wiki
  128. ```
  129. Then open `/wiki-app` on your site. For more, see [Install Frappe Wiki](docs/introduction/install-frappe-wiki.md).
  130. ## Development setup
  131. ### Local
  132. 1. Set up a bench with [Frappe Pilot](https://github.com/frappe/pilot#readme), or with the [bench CLI](https://frappeframework.com/docs/user/en/installation), and start it:
  133. ```sh
  134. bench start
  135. ```
  136. 2. In another terminal, in the `frappe-bench` folder, get the app and install it on your site:
  137. ```sh
  138. bench get-app https://github.com/frappe/wiki
  139. bench --site <site> install-app wiki
  140. ```
  141. <details>
  142. <summary><b>Work on the documentation</b></summary>
  143. <br>
  144. The user guide is in [`docs/`](docs/introduction/what-is-frappe-wiki.md). GitHub Sync publishes it, and [`docs/.wiki.yml`](docs/.wiki.yml) sets the order of the sidebar. To see your changes as you write, preview the folder on a development site. The command syncs again when you save a file, and open pages reload:
  145. ```sh
  146. bench --site <site> wiki preview-docs apps/wiki/docs --route docs-preview --watch
  147. ```
  148. The screenshots are in `docs/images/`, in a light and a dark version. [`scripts/docs-screenshots/`](scripts/docs-screenshots/README.md) takes them again from a site with demo data.
  149. </details>
  150. <details>
  151. <summary><b>Run the tests</b></summary>
  152. <br>
  153. ```sh
  154. # Python tests
  155. bench --site <site> run-tests --app wiki
  156. # Browser tests, against a running site
  157. yarn test:e2e
  158. ```
  159. </details>
  160. ## Learn and connect
  161. - [Telegram Public Group](https://t.me/frappewiki)
  162. - [Discuss Forum](https://discuss.frappe.io/c/wiki/72)
  163. - [Documentation](docs/introduction/what-is-frappe-wiki.md)
  164. - [YouTube](https://www.youtube.com/@frappetech)
  165. <br>
  166. <br>
  167. <div align="center" style="padding-top: 0.75rem;">
  168. <a href="https://frappe.io" target="_blank">
  169. <picture>
  170. <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png">
  171. <img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/>
  172. </picture>
  173. </a>
  174. </div>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.