Skip to content
Back to search

foliowiki

MarketplaceWorks with Claude CodeGitHub

Plugins that connect AI coding agents to a Folio (foliowiki) wiki over MCP.

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/evergreen-it-dev/folio 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/evergreen-it-dev/folio'

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/evergreen-it-dev--folio/badge.svg)](/listings/evergreen-it-dev--folio)

HTML

<a href="/listings/evergreen-it-dev--folio"><img src="/api/listings/evergreen-it-dev--folio/badge.svg" alt="findsafeskills safety rating" /></a>

Install

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.

.claude-plugin/marketplace.json · Manifest · 15 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. {
  2. "name": "foliowiki",
  3. "description": "Plugins that connect AI coding agents to a Folio (foliowiki) wiki over MCP.",
  4. "owner": {
  5. "name": "Evergreen",
  6. "url": "https://github.com/evergreen-it-dev"
  7. },
  8. "plugins": [
  9. {
  10. "name": "foliowiki",
  11. "source": "./integrations/claude-code",
  12. "description": "Read and update your team's Folio wiki from Claude Code: the Folio MCP server and a skill that tells the agent how to work with pages, tables and boards."
  13. }
  14. ]
  15. }
README.md · README · 974 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. # Folio
  2. **The open-source alternative to Notion and Confluence.**
  3. Your team's wiki lives in Git. People write in the browser, together, in real
  4. time. AI agents read and write the same pages. One command to run it yourself.
  5. Website: <https://foliowiki.online> · Featured in [Self-Host Weekly (9 Oct 2026)](https://selfh.st/weekly/2026-10-09/)
  6. ### 👉 [Try the live demo](https://demo.foliowiki.online/?utm_source=github&utm_medium=readme&utm_campaign=repo)
  7. No install, no sign-up: open it and pick Sam on the sign-in screen. Shared login, data resets every 24 hours; don't enter personal data or API keys.
  8. ![Folio: a page with Folio AI at work, a whiteboard and a data table](docs/images/overview.png)
  9. ```bash
  10. git clone https://github.com/evergreen-it-dev/folio.git
  11. cd folio
  12. docker compose up -d
  13. ```
  14. Open <http://localhost:4870>, create the first account, start writing.
  15. Not ready to install? [Try the live demo](https://demo.foliowiki.online/?utm_source=github&utm_medium=readme&utm_campaign=repo) first.
  16. ---
  17. ## Why Folio
  18. - **You own the content.** Every page is a plain file in a Git repository you
  19. control. No export step, no lock-in: stop using Folio tomorrow and the files
  20. are still there, readable in any editor.
  21. - **It works the way a wiki should.** Real-time editing, a page tree, search,
  22. access rights, history, sharing — and it keeps working offline.
  23. - **Agents are first-class users.** Not a chatbot bolted on the side: a
  24. built-in assistant, your own agent in every space, a full MCP server, and
  25. Markdown links made for agents.
  26. - **Documents, tables, whiteboards, diagrams and files in one tree.** A
  27. roadmap table next to the spec, next to the architecture board, next to the
  28. signed PDF. Obsidian canvases and bases open as pages, too, and so do the
  29. interactive artifacts your agents make.
  30. - **See how your pages connect.** A graph of the space and a local graph beside
  31. every page, built from the links your team already writes, and showing only
  32. what the reader may open.
  33. - **Built for teams.** Groups, single sign-on with OpenID Connect and SAML 2.0,
  34. SCIM provisioning, an audit log and page restrictions that child pages inherit.
  35. - **Publish what should be public.** Turn a space into a read-only website,
  36. with search and an optional "Ask AI" for visitors, at a path of your
  37. instance, on a subdomain or on your own domain.
  38. - **One command to run.** Docker, and nothing to configure for a first start.
  39. ---
  40. ## See it in action
  41. Short walkthroughs, no slides. The voice in the videos is synthetic.
  42. - [A team wiki that lives in Git](https://youtu.be/tm1xB9x9HeY) — edit a page in the browser, press Sync, and it is a real Git commit; a teammate edits from the terminal and the change shows up on the page (0:37)
  43. - [An AI agent updates your wiki over MCP](https://youtu.be/3ORtBgYlIeY) — one request: the agent reads the release process, writes release notes and adds a roadmap row (0:53)
  44. - [Onboarding a sales rep with Folio AI](https://youtu.be/T4JXTNRrsMg) — answers from the team's own pages with sources, a weekly check as a form, and the results in a table (1:22)
  45. - [Whiteboards that live in Git](https://youtu.be/HNK17qafhtc) — draw together, embed the board in a document, and keep every version in history (0:51)
  46. - [Docs as code without the IDE](https://youtu.be/_e3qILMTFKg) — the `docs/` folder of a product repository becomes a space; a technical writer edits it by hand and with Folio AI, an agent adds a release entry over MCP, and the developer reads the commits with `git pull` (1:36)
  47. - [Publish a space as a public website, with Ask AI for visitors](https://youtu.be/L8Qd4gm_0d4) — one setting makes a space a read-only site on a path, a subdomain or your own domain; visitors search it, download pages and ask Folio AI (1:21)
  48. - [The editor and Mermaid diagrams](https://youtu.be/MfK7bhKoxSs) — live Markdown, a source view of the same page, and diagrams you edit visually or as code (1:04)
  49. - [Is your wiki's AI assistant helping? Folio AI analytics](https://youtu.be/7aszLTDQV8w) — instance admins see rated conversations and unanswered questions, add the missing page, and the same question gets an answer with its source (1:21)
  50. - [Publish Claude artifacts into your team wiki](https://youtu.be/F4pZzJLTf-U) — one casual line to Claude Code: the dashboard becomes an interactive page of the wiki, keeps the reader's filters after a reload, is a folder in Git, and opens for a guest by a share link (1:33)
  51. ---
  52. ## Git-first, all the way down
  53. Most wikis keep your content in a database and offer Git as an export. Folio
  54. does the opposite: **the Git repository is the wiki**. The database holds the
  55. index, access rights and the state of live editing — never the only copy of
  56. your words.
  57. This is what a space looks like on disk:
  58. ```text
  59. acme-handbook/
  60. ├── index.md
  61. ├── welcome-to-acme.md
  62. ├── engineering.md
  63. ├── engineering/
  64. │ ├── onboarding-checklist.md
  65. │ ├── release-process.md
  66. │ ├── incident-runbook.md
  67. │ └── how-folio-fits-together.excalidraw.svg ← a whiteboard
  68. ├── meeting-notes.md
  69. ├── meeting-notes/
  70. │ └── product-sync-september-28.md
  71. ├── roadmap.table.md ← a data table
  72. ├── onboarding-feedback.table.md
  73. ├── onboarding-feedback/
  74. │ └── onboarding-feedback.form.md ← a form
  75. ├── security-policy.md
  76. ├── security-policy.pdf ← files are pages too
  77. └── security-policy.docx
  78. ```
  79. And this is its history — ordinary commits, with the people who made the
  80. changes as authors:
  81. ```text
  82. $ git log --format='%h %an %s'
  83. be529a0 Maria Chen folio:update
  84. aeac3bb Maria Chen folio:update
  85. 6c2c061 Sam Rivera folio:update
  86. 026d9ec Maria Chen folio:update
  87. ...
  88. 4e9ec49 Folio init: create space
  89. ```
  90. What that gives you:
  91. - **Edit anywhere.** Change a page in the browser or in your IDE and push —
  92. both land in the same history. Links between pages are ordinary relative
  93. Markdown links, not a private dialect.
  94. - **Bring your own repository.** Start with an empty space, clone an existing
  95. repository, or connect one later. Several spaces can share one repository,
  96. each in its own folder — so documentation can live right next to the code.
  97. - **Review like code.** Merge requests, blame, diff and revert work on your
  98. wiki because it *is* a repository.
  99. - **Docs-as-code friendly.** Front matter keys written by Docusaurus, MkDocs,
  100. Hugo or Jekyll are kept byte for byte; a space bound to a folder such as
  101. `docs/` writes no ids into your files (a space over a whole repository does);
  102. images can be stored in the repository next to the page and linked by a
  103. relative path, so GitHub shows them; and moving a page rewrites the links
  104. that point to it and the ones inside it, in one commit. A full scenario is in
  105. [Docs as code, without the IDE](#docs-as-code-without-the-ide).
  106. - **Nothing is lost quietly.** Sync state is always visible — clean, ahead,
  107. behind, conflict — and conflicts are listed for the whole space. "Take the
  108. version from Git" resets a space to the remote branch and saves what was
  109. there into a backup branch first.
  110. - **Readable formats.** A whiteboard is an SVG that opens in any browser and
  111. still carries the editable scene. A data table is one Markdown file — the
  112. column types and saved views in the front matter, the rows as a table you
  113. can read:
  114. ```markdown
  115. # Roadmap
  116. | Initiative | Status | Owner | Team | Due | Effort, days | Urgent | id |
  117. | --- | --- | --- | --- | --- | ---: | --- | --- |
  118. | Single sign-on for enterprise plans | In progress | @alex | Engineering | 2026-10-09 | 8 | [x] | 1787nfg3 |
  119. | New onboarding flow | In review | @sam | Design | 2026-10-02 | 5 | [ ] | b227mwwh |
  120. | Pricing page redesign | Planned | @sam | Design | 2026-10-16 | 3 | [ ] | ndxvtpa3 |
  121. ```
  122. ![Page history with authors](docs/images/history.png)
  123. ---
  124. ## Docs as code, without the IDE
  125. If your documentation lives in the `docs/` folder of a product repository,
  126. Folio can show that folder as a space. Writers edit it in a browser, developers
  127. keep their IDE and read ordinary commits, and an agent works on the same pages.
  128. - **Connect the folder, not the repository.** Create a space from the
  129. repository URL, choose the branch and pick `docs/` as the root path. Only
  130. that folder becomes the space: Markdown files are pages; source code and
  131. other files are not pages and are never touched. Folio keeps its page ids in
  132. its own index, and the only file it adds is a hidden `docs/.<slug>.folio`.
  133. - **A writer edits in the browser.** Reading, Live edit or Source (plain
  134. Markdown), several people on one page, or a request to Folio AI in the side
  135. panel. Folio writes each edit to the file at once and commits after about 90
  136. seconds of quiet, or immediately on Sync, to the branch the space follows.
  137. - **A developer sees a commit with the author's name.** `git pull`, `git log`
  138. and `git blame` show the person who edited as the author; Folio is the
  139. committer and the message is `folio:update`. Only the last editor in a window
  140. is recorded as author. The developer's own commits come back into the space
  141. by fetch roughly every three minutes and on every Sync.
  142. - **An agent updates pages through MCP.** Claude Code, Cursor or any MCP
  143. client connects with a personal access token or through OAuth, reads and
  144. edits the same pages with the rights of the token's owner and no more, and
  145. the commit carries that person's name.
  146. - **The space can become a docs portal.** Make it public and the same pages
  147. are served as a read-only website with search and, if you switch them on,
  148. downloads and "Ask AI" for visitors, see [Publish a space as a website](#publish-a-space-as-a-website).
  149. Where it stops: a space follows exactly one branch and Folio pushes straight to
  150. it, without pull requests (point the space at a `docs` branch if you want
  151. review before `main`; a protected branch makes the push fail and the space
  152. shows git's message). A space over the whole repository, with no root path,
  153. writes an `id` into every page and a small file into the repository root,
  154. unless an administrator ticks "Light footprint" (a repository with `.obsidian/`
  155. is detected on its own). Opening a page writes nothing: a file changes only
  156. when someone edits it. A page's title comes from its first `#` heading, then
  157. from a front matter `title:`, then from the file name, and Folio does not add a
  158. heading to a page that has none. An `id` that another tool put in front matter
  159. (Docusaurus and Jest use `id: intro`) never moves a page between spaces. MDX
  160. files (`.mdx`: Nimbus, Starlight, Astro, Docusaurus) are pages like `.md`
  161. ones: `import`/`export` lines and JSX components such as `<Aside>` or `<Tabs>`
  162. are folded into compact blocks in Live edit, drawn as labelled boxes in Reading,
  163. and saved back byte for byte — Folio does not run MDX, it only keeps it intact.
  164. Pasted images
  165. stay in Folio's asset store until a space administrator turns on "Store images
  166. in the repository". See also [What is not there yet](docs/LIMITATIONS.md).
  167. The walkthrough is in the post
  168. [Docs-as-code without the IDE: edit your repository's docs in a browser](https://foliowiki.online/blog/docs-as-code-in-the-browser/)
  169. and in the [video](https://youtu.be/_e3qILMTFKg).
  170. ---
  171. ## Write together
  172. Documents, data tables and whiteboards are edited by several people at once.
  173. You see who is on the page and where their cursor is; changes appear as they
  174. are typed. When the page goes quiet, Folio commits — with the person who
  175. edited as the author.
  176. ![Three people editing one page](docs/images/collab.png)
  177. What you type is not lost between Live edit and Reading: the browser keeps a
  178. local copy until the server confirms it has your edits. If it cannot confirm
  179. them, the header says **Not saved** and closing the tab asks first.
  180. **Comments on text.** Select a passage in a document and press **Comment**: the
  181. thread sits beside the page, anyone who can see the page can reply, and an
  182. editor (or the person who started it) resolves it. Comments are kept in the
  183. database, not in the Markdown, so Git history stays clean. Agents read and
  184. answer them through MCP.
  185. **Mentions and notifications.** Type `@` in a comment to pick a person from the
  186. space. The bell reports an @mention and a reply in a thread you took part
  187. in; a comment written by an agent through MCP notifies in the same way. There
  188. is no email. Comments can also be attached to a single element of a whiteboard
  189. or to a cell of a data table; the link in a notification opens the thread and
  190. shows the element or the cell.
  191. ---
  192. ## Side-by-side comparison
  193. Two translations of one page, this quarter's plan next to last quarter's, a spec
  194. next to the draft that should follow it: put up to five pages, or older versions
  195. of a page, side by side.
  196. ![Two pages side by side, the left one as a reader sees it and the right one open for editing](docs/images/compare-live.png)
  197. - **Collect, then open.** "Compare side by side" is in the sidebar menu (also for
  198. people who can only read), in the page header and in the history panel. A chip
  199. at the bottom of the window holds the list, from any spaces you can open.
  200. - **Live columns.** A current page is the page itself, with the same editor and
  201. live collaboration: type in a column and everyone on the page sees it.
  202. - **Versions next to the page.** In a page's history, "Compare side by side with current" puts
  203. a read-only version beside the live page. "Highlight changes" marks what is new
  204. or changed in green and what was removed in red against the leftmost column,
  205. and synchronized scrolling keeps the columns together.
  206. ![A page next to an older version of itself, with the changes highlighted](docs/images/compare-highlight.png)
  207. - **A link to share.** "Copy link" copies an address with only page ids and
  208. version numbers; whoever opens it sees each column with their own access.
  209. Highlighting compares text block by block. See
  210. [docs/LIMITATIONS.md](docs/LIMITATIONS.md).
  211. ---
  212. ## Works offline
  213. On a train, on a plane, on bad hotel Wi-Fi — keep writing.
  214. - Pages and whiteboards you have opened stay editable without a connection.
  215. - New pages and whiteboards can be created offline and appear in the tree
  216. straight away.
  217. - Everything is kept on the device and reaches the server by itself when the
  218. connection returns — at the same address, with no duplicates.
  219. - Nothing is lost if you switch pages or close the tab.
  220. - An indicator in the header shows what is waiting to be sent.
  221. ![Writing a new page without a connection](docs/images/offline.png)
  222. Data tables, forms and file uploads need a connection.
  223. ---
  224. ## Documents
  225. A Markdown editor that does not make you think about Markdown. Three modes —
  226. **Reading**, **Live edit** and **Source** — so that writers and engineers are
  227. both at home.
  228. ![The editor with a diagram, a checklist and a callout](docs/images/editor.png)
  229. - Callouts, checklists, tables with merged cells and colors, code blocks,
  230. collapsible sections, highlights, `++underline++`, and coloured status
  231. tags like `:status[Done]{color=green}`.
  232. - Paste from Excel and Google Docs keeps tables and formatting; copying out of
  233. Live edit keeps it too.
  234. - `[[` links a page, `@` mentions a person, `/` inserts anything.
  235. - `::pagetree` puts a live tree of child pages right into the text.
  236. - Outline and notes panel, backlinks, page icons and covers, glossary terms
  237. with hover cards.
  238. - Custom templates: any page in `_templates/`, even with subpages, becomes a
  239. template, with a name and description ("Make template", "From template…"); a
  240. new space starts with three.
  241. - Light and dark themes, following the system or chosen by hand.
  242. ![The same page in the dark theme](docs/images/document-dark.png)
  243. ---
  244. ## Diagrams you draw, not type
  245. Mermaid diagrams come with a visual editor. You build the diagram on a canvas,
  246. and Folio writes the Mermaid code for you — or you type the code and watch the
  247. canvas follow. Both sides stay in sync.
  248. ![The visual Mermaid editor](docs/images/mermaid.png)
  249. - **Click to build.** A plus on a node adds a connected one, a plus on a link
  250. inserts a node into it, a handle drags a new link from node to node.
  251. - **Nine diagram types from templates**: flowchart, sequence, classes, states,
  252. ER, Gantt, timeline, pie, mind map.
  253. - **Code and canvas side by side**, full screen when you need room, and a
  254. readable message instead of a broken picture when the syntax is wrong.
  255. - **Still plain Markdown.** The diagram is stored as an ordinary `mermaid`
  256. code block, so GitHub and GitLab render it too.
  257. ---
  258. ## Data tables
  259. Spreadsheets that belong to the wiki: typed columns, saved views, filters and
  260. sorting — a small database you can link from any page and query from any
  261. agent.
  262. ![A roadmap as a data table](docs/images/table.png)
  263. - Column types: text, long text, number, date, checkbox, select, status, user,
  264. link.
  265. - Views as tabs, each with its own columns, order, widths, multi-column sort
  266. and `and`/`or` filters — including "me", "today", "this week".
  267. - Edited together in real time, stored as one readable file in Git.
  268. - Import and export; up to 20,000 rows per table.
  269. **Forms** turn a table into a questionnaire: every answer becomes a row. A
  270. form can be public, so people answer without an account.
  271. ![A form that writes into a table](docs/images/form.png)
  272. ---
  273. ## Whiteboards
  274. Excalidraw boards inside the wiki — architecture, flows, workshops. Drawn
  275. together in real time and saved as SVG files that render anywhere.
  276. ![A whiteboard](docs/images/board.png)
  277. The board above was not drawn by hand. An agent created it through MCP from a
  278. short description of boxes and arrows; people then keep editing it like any
  279. other board.
  280. **Reactions.** Select a shape in Edit mode and a small button appears at the
  281. corner of its selection frame: pick an emoji (✅ ❌ 🔧 for yes, no and in progress, or 👍 ❤️ 😂 🎉 🤔 👀 🔥 👏)
  282. and a counter chip shows under the shape.
  283. Click a chip to add or remove your own; point at it to see who reacted.
  284. Reactions are live for everyone on the board, and people who can only view it
  285. (or are in View mode) see them too but cannot click them. They are kept with the board's live state, not in its SVG file.
  286. ---
  287. ## Graph
  288. Every link between pages is already in the index, so Folio can draw it. Open
  289. **Graph** under the tag tree and the space appears as a map: pages are nodes,
  290. links are edges, and the biggest hubs carry their names.
  291. ![The graph of a space: pages as nodes, links as edges, folders as colours](docs/images/graph.png)
  292. - **Labels follow the zoom.** At the overview only the top hubs are named;
  293. zoom in and more titles fade in, never one on top of another. A hovered or
  294. selected page and its neighbours always keep their labels.
  295. - **Tree structure included.** A "Tree structure" toggle adds the page tree as
  296. dashed lines, so a nested space is not a cloud of unconnected dots. A page of
  297. another space you may open shows up with its space in its name, in its own
  298. colour.
  299. - **A local graph beside every document.** The page and its neighbours one to
  300. three links away, in, out or both, in the right-hand panel; click a node to
  301. open the page, or expand it to full size.
  302. ![A page with its local graph in the side panel](docs/images/graph-local.png)
  303. - **Filters in the search grammar** (`tag:`, `in:`, `kind:`, `prop:`), colour
  304. groups by top folder, page kind, tag or your own query, and the layout forces
  305. are settings of the graph, remembered per space.
  306. - **Access is applied in the query.** A page you cannot open is never a node, a
  307. ghost or an edge. The graph is built on the server from the page index (5,000
  308. pages in about 150 ms) and the drawing code loads only when a graph is opened.
  309. - **Agents can read it too.** The MCP tool `get_graph` returns the same graph, and
  310. the built-in assistant uses it.
  311. The limits (10,000 pages, no graph on public sites) are in
  312. [docs/LIMITATIONS.md](docs/LIMITATIONS.md).
  313. ---
  314. ## Obsidian canvases and bases
  315. An Obsidian vault is not only Markdown, and Folio now opens two more of its
  316. file types as pages.
  317. ![An Obsidian canvas rendered as a page](docs/images/canvas.png)
  318. - **Canvases (`.canvas`).** Text cards rendered as Markdown, note cards with the
  319. note's start, images, web page cards, groups and connections with arrows and
  320. colours, with pan, zoom and fit. A card that points at a page you may not open
  321. says "No access". "Convert to Folio board" makes a new, editable whiteboard in
  322. one commit and leaves the canvas as it was.
  323. - **Bases (`.base`).** A saved query over the pages of a space, shown as a table,
  324. cards or a list, with grouping, sorting, formulas and column summaries. An Edit
  325. toggle changes a cell in place by changing that page's property, and a visual editor
  326. changes views, filters and formulas without disturbing the rest of the file.
  327. ![An Obsidian base as a grouped table with summaries](docs/images/base.png)
  328. ![The visual editor of a base](docs/images/base-editor.png)
  329. Both follow renames: move a note and the canvas cards and wikilinks that point
  330. at it are rewritten in the same commit. Bases run in a safe evaluator of our own
  331. (no `eval`); `kanban` and `map` views and plugin functions are not supported.
  332. Details and limits: [docs/LIMITATIONS.md](docs/LIMITATIONS.md).
  333. ---
  334. ## Artifacts: publish Claude artifacts and Cursor canvases
  335. An AI agent builds a dashboard, a calculator or a small tool; usually it
  336. lives in a chat and is gone with it. In Folio it becomes a page: in the tree,
  337. in search, in Git, under the same access rights as everything else.
  338. ![An interactive artifact: a sales dashboard with region filters, cards and a chart, as a page of the wiki](docs/images/artifacts.png)
  339. - **Interactive, not a screenshot.** Filters, tabs, charts and forms work on
  340. the page. The page runs in a sandboxed frame with no access to your Folio
  341. session or API, and loads scripts and fonts only from a short list of CDNs
  342. (cdnjs, jsDelivr, unpkg, esm.sh, Tailwind, jQuery, Google Fonts).
  343. - **State survives.** `window.storage` (the API Claude artifacts use) and
  344. `localStorage` work and are kept per reader: in the database for people who
  345. are signed in, in the browser for guests.
  346. - **Publish from the agent.** The MCP tool `publish_artifact` creates an
  347. artifact page or replaces an existing one, with extra files and the original
  348. source (JSX or TSX) kept next to it. In Claude or Cursor with Folio connected,
  349. say "publish this artifact to Folio".
  350. - **Or import it by hand.** "Artifact…" in the "+" menu takes a link to an
  351. `.html`, `.zip`, `.svg` or `.md` file, a file from your computer, or pasted
  352. HTML. "Show source" and "Download" are on the page; replacing an artifact keeps
  353. its link and place in the tree.
  354. - **Files in Git.** An artifact is a folder `<name>.artifact/` in the space's
  355. repository: `index.html`, an `artifact.yaml` manifest, the source and assets.
  356. Move, copy, trash, share links, public sites and history work like for any
  357. page.
  358. A short walkthrough: [Publish Claude artifacts into your team wiki](https://youtu.be/F4pZzJLTf-U) (1:33).
  359. Folio shows the finished page; it does not build React or TSX itself, so an
  360. agent sends HTML that already runs, and calls to Claude, to your own APIs or to
  361. connectors are not available inside an artifact. Share links from claude.ai or
  362. Cursor are not downloaded: ask the agent to publish through MCP. See
  363. [docs/LIMITATIONS.md](docs/LIMITATIONS.md).
  364. ---
  365. ## Properties and a shared timer
  366. **Properties on every kind of page.** The thin "Properties" row above a page now
  367. appears on data tables, forms, boards and files, not only documents. A board keeps
  368. its properties in a small sidecar file in Git, next to the board, and they work in
  369. search (`tag:`, `prop:`), the tag tree and MCP like any other.
  370. ![The properties of a whiteboard, edited in the page header](docs/images/properties-board.png)
  371. **Owner and review date.** A page can have an owner and a date by which it
  372. should be checked, kept in Git as the properties `owner`, `verified` and
  373. `review_by`. **Mark as verified** in the properties section sets the next date
  374. (90 days by default). A badge under the title shows **Verified**, **Changed
  375. after verification** or **Review overdue**, and agents get the state in a
  376. `verification` block of `read_page`. Overdue pages remind their owner (or the
  377. space admins) in the bell, at most once a week per page.
  378. **A timer that belongs to the page.** The clock icon in the header starts a
  379. countdown (1, 3, 5 or 10 minutes, or your own) that everyone who has the page open
  380. sees and hears end together, for a workshop or a retro. Editors control it, readers
  381. watch.
  382. ![A running timer in the page header, with its pause, +1 minute and reset controls](docs/images/timer.png)
  383. ---
  384. ## Document preview
  385. PDF, Word, Excel and PowerPoint files are pages too. Drop one into the tree
  386. and it opens right inside Folio — no download, no other application, no
  387. conversion on the server.
  388. ![A PDF previewed inside Folio](docs/images/pdf.png)
  389. ![A Word document previewed inside Folio](docs/images/docx.png)
  390. - **PDF** in the browser's own viewer: thumbnails, zoom, search, print.
  391. - **Word, Excel and PowerPoint** rendered in the browser.
  392. - The file sits in the space's Git repository next to the pages about it, in
  393. the same tree, under the same access rights.
  394. - Open in a new tab or download with one click.
  395. - Folio never rewrites your file: what you uploaded is byte for byte what is
  396. stored.
  397. - **A new version of the file, same page.** "Replace with new version…" in
  398. the tree menu, the button in the page header, or drag a file onto the open
  399. page. The page keeps its link, place in the tree and access; the new file
  400. may even be another type (a deck that became a PDF), and links to it from
  401. other pages are rewritten. A toast offers Undo.
  402. - **Every version stays.** Each replace is its own commit. The page history
  403. lists the versions with their file name and size, lets you download any of
  404. them (or preview a PDF) and restore one, which adds one more commit rather
  405. than rewriting anything.
  406. These files are for viewing: they are not edited in Folio, and search finds
  407. them by title.
  408. ---
  409. ## Folio AI
  410. An assistant in the side panel that works with your wiki, not next to it.
  411. ![The assistant adds a row to the roadmap and answers from the data](docs/images/ai.png)
  412. In the screenshot the assistant was asked to add an initiative to the roadmap
  413. and say which ones are urgent. It read the table's schema, inserted the row —
  414. it appears in the table on the left — and answered from the data.
  415. - **Ask** — read-only. Find, summarize, compare, explain across the pages you
  416. have access to.
  417. - **Agent** — reads and writes. Drafts a page, updates a table, draws a board,
  418. builds a form, restructures a section — inside your rights, never beyond them.
  419. - **Runs live on the server.** Close the browser and the work continues; come
  420. back and pick up where it was.
  421. - **You see what it is doing.** The status line shows the model's thinking
  422. with a token counter, an elapsed-time counter while it writes a long answer or
  423. page, and the real name of the tool it is calling; the live reply keeps its
  424. paragraphs and links.
  425. - **The same tools as everyone else.** The assistant works through the very
  426. tools an outside agent gets over MCP — there is no second, weaker
  427. implementation, and in Ask mode the write tools are switched off on the
  428. server, not just hidden.
  429. **It builds forms and tables, not only text.** Ask for "a lunch poll with a
  430. required name, a cuisine and a yes/no for Friday" and the agent creates the form
  431. and the table its answers land in, with the same steps as the form editor.
  432. ![Folio AI in Agent mode has built a form, and the form is on the page next to the chat](docs/images/assistant-form.png)
  433. ### Is the assistant actually helping?
  434. Folio collects three signals about answer quality, without asking anyone to
  435. fill in a form:
  436. - **👍 / 👎 on an answer.** Every saved assistant answer can be rated
  437. "Helpful answer" or "Not helpful". One rating per answer, and you can change
  438. or remove it.
  439. - **A short survey.** After every third answer in a conversation the panel
  440. asks "Did the assistant solve your question?" — Yes, Partly, No or Not now —
  441. with an optional comment.
  442. - **Questions without an answer.** When the pages do not contain the answer,
  443. or the assistant is not sure of it, it records the question and what was
  444. missing — briefly, with links to the pages it did read — then still answers
  445. the person plainly.
  446. Instance administrators see all of it on one page, **Assistant analytics**
  447. (`/admin/assistant`, from the account menu): the conversations with their
  448. ratings and survey results, and a second tab, "Questions without an answer",
  449. which is a ready list of what your documentation is missing — the person's own
  450. words first, the assistant's restatement below, and links to the pages
  451. the assistant read. Both tabs filter by space,
  452. user and date. A space administrator sees the same page limited to the spaces
  453. they administer: only conversations that ran there, and only the messages of
  454. those runs. An administrator can open a conversation to read it; the
  455. conversation page lists who opened it and when, and every opening is written
  456. to the audit log. Other people do not see this page.
  457. ![Assistant analytics: the list of questions the pages could not answer, with the person's words, the space and what is missing](docs/images/assistant-unanswered.png)
  458. ### Your own agent in every space: `.agent`
  459. Every space has a `.agent` folder. Whatever you put there becomes the
  460. assistant's instructions **for that space** — and it is written as ordinary
  461. Folio pages, not as configuration.
  462. - **Build an agent by writing pages.** Its role, its tone, the glossary, the
  463. rules it must follow, the templates it should use, the process it should
  464. walk people through.
  465. - **A different agent for every team.** The support space gets an agent that
  466. answers like support. The engineering space gets one that knows the release
  467. process. Legal gets one that never improvises. Same Folio, different
  468. agents.
  469. - **Versioned like everything else.** The instructions live in Git: you can
  470. see who changed the agent's behavior, review the change, and roll it back.
  471. - **Owned by administrators.** Only space administrators see and edit
  472. `.agent`; everyone else just gets a better assistant.
  473. The instructions apply to every run in the space, in Ask and Agent modes
  474. alike.
  475. **Writing rules, checked before you ship.** Put a page named
  476. `writing-rules` in `.agent` (administrators get a "Create writing rules"
  477. button that adds a starter: plain language, one idea per paragraph, headings
  478. as nouns, no marketing words, define acronyms, numbered steps) and every page
  479. of the space can be linted against it, whoever wrote it. Open a page and choose
  480. **Check against writing rules**: the assistant runs read-only and lists each
  481. finding with the rule it breaks, the quoted fragment and a suggested rewrite;
  482. **Fix with Agent** hands the findings to Agent mode, which edits only those
  483. fragments. The check needs the rules page and a working Folio AI key; without
  484. them the button is missing or disabled with the reason. External agents (Claude
  485. Code, Cursor) call the MCP tool `check_page_writing_rules` to get the same
  486. rules and the page before they write.
  487. ### Bring your own key
  488. Folio does not resell AI and does not mark it up. The assistant runs on a key
  489. you already have: your own, or one that an administrator provides for a space
  490. or for the whole instance. Whoever owns the key pays.
  491. | Provider | How it connects |
  492. |---|---|
  493. | Cursor | a Cursor key: personal, of a space or of the instance |
  494. | Claude | an Anthropic API key billed by usage (`claude-opus-5-5`, `claude-sonnet-5-5`, `claude-haiku-5-5`): personal, of a space or of the instance; a Claude subscription cannot be used |
  495. The model picker groups models by provider. Claude remembers only the text of
  496. earlier messages in a conversation, not earlier tool results. A reply is
  497. produced by the selected provider, so the pages the assistant reads go to it.
  498. **Who pays.** A run uses the first key that exists: the person's own key, then
  499. the key of the space, then the key of the instance, then `CURSOR_API_KEY` from
  500. the server environment (`CURSOR_API_KEY` or `ANTHROPIC_API_KEY`, per provider). A space administrator sets a space's key (space menu,
  501. "Folio AI key"); an instance administrator sets the instance key and can turn
  502. personal keys off, so everyone uses the shared one. Shared keys are stored
  503. encrypted and are never shown again after saving; every change is in the audit
  504. log. Visitors of a [public site](#publish-a-space-as-a-website) have no key of
  505. their own, so their questions run on the key of the space, of the instance or
  506. of the server environment, in that order: Cursor when it resolves, else a
  507. shared Claude key. A personal key is never used there.
  508. Without a key everything else in Folio works as usual.
  509. ---
  510. ## Built for agents
  511. **MCP server.** 51 tools over `/mcp`: list and search spaces, read and write
  512. pages, build forms, edit data table columns and views, convert a canvas to a board, read a page's outline, tags, properties and links, list a space's tags and
  513. property keys, rename a tag, set page properties, find unresolved links
  514. and orphan pages, read the link graph, query, create and edit Obsidian bases, create and edit whiteboards, publish interactive artifacts, list templates and create pages from them, query and update data tables,
  515. read history, read and write comment threads, check a page against the space's writing rules.
  516. Connect with a personal access token, or through OAuth 2.1 from clients that
  517. run in a vendor's cloud (claude.ai, Claude Desktop, ChatGPT). `search` and
  518. `fetch` are there for ChatGPT deep research.
  519. ```bash
  520. claude mcp add folio --transport http https://wiki.example.com/mcp \
  521. --header "Authorization: Bearer folio_pat_…"
  522. ```
  523. **Ready-made setups.** Files for Claude Code (a plugin and a skill), Cursor,
  524. VS Code, Codex, n8n (two importable workflows), Open WebUI, ChatGPT and Claude
  525. live in [integrations/](integrations/): configs with placeholders, rules for
  526. the agent and step-by-step instructions.
  527. **Review of agent edits.** In the space menu, **AI agents**, a space admin can
  528. switch from **Edit at once** to **Send edits for review**. Then `update_page`,
  529. `create_page` and `PUT /api/pages/:id` with an API token create a proposal, and
  530. the page changes only when an editor or admin accepts it in the **On review**
  531. list, which shows line-by-line differences. Only Markdown pages are covered.
  532. **Team skills.** A page tagged `skill`, with a `description` property, is
  533. offered to every connected agent through `list_skills`, `get_skill` and MCP
  534. prompts, so the team's instructions live in the wiki and not in a prompt file on
  535. each machine. Details: [docs/TEAM-SKILLS.md](docs/TEAM-SKILLS.md).
  536. **Markdown for an agent.** Any page — with its child pages, if you want — is
  537. one link that returns clean Markdown. No scraping, no HTML, no login flow:
  538. ```bash
  539. curl https://wiki.example.com/share/<token>.md
  540. ```
  541. ![Sharing a page as Markdown for an agent](docs/images/share.png)
  542. **Export in the formats agents and people need**: Markdown, YAML, PDF, DOCX,
  543. or a zip of a whole space.
  544. For claude.ai or ChatGPT, add `https://wiki.example.com/mcp` as a custom
  545. connector, sign in to Folio and allow `read` or `read` + `write` on the consent
  546. screen. The connector acts with your rights and its writes are saved in Git
  547. under your name. Steps: [docs/MCP.md](docs/MCP.md#oauth-connect-from-claudeai--chatgpt).
  548. **Safe by design.** A token or an OAuth grant never has more rights than its
  549. owner, a `read` token cannot write, and administrative actions are not
  550. available to either at all. Details: [docs/MCP.md](docs/MCP.md).
  551. ---
  552. ## Moving from Confluence
  553. Point Folio at a Confluence page or a whole tree and it brings the pages over
  554. as Markdown — with images, code, checklists, and panels converted into
  555. callouts. Pages come from Confluence Cloud and from on-premises
  556. installations; whiteboards from Confluence Cloud become Excalidraw boards.
  557. Run a test import first: not every macro has an equivalent.
  558. [What is not there yet](docs/LIMITATIONS.md) is written down honestly.
  559. ---
  560. ## Access management
  561. Who sees what is decided in one place, and it is visible at a glance.
  562. ![The access matrix: people and spaces](docs/images/access.png)
  563. - **Roles per space**: administrator, editor, viewer.
  564. - **Private, open or public spaces.** A private space is visible to its members
  565. only. A space open to the instance gives every signed-in person read access,
  566. and edit rights still have to be granted. A public space is also readable by
  567. anyone on the internet as a website, see
  568. [Publish a space as a website](#publish-a-space-as-a-website).
  569. - **The access matrix.** People down the side, spaces across the top, a role
  570. in every cell. Change one cell or many at once.
  571. - **An administrator is not a reader.** The instance administrator manages
  572. people and access but does not see the content of a private space they are
  573. not a member of. They can grant access to themselves — and that is written
  574. to the audit log and marked for everyone to see.
  575. - **Audit log.** Every grant, revoke and visibility change is recorded with
  576. who did it and when. Instance administrators get a screen with filters and a
  577. CSV export, see [Groups and single sign-on](#groups-and-single-sign-on).
  578. **Page-level access.** Any page can be narrower than its space: open to all
  579. members, to you only, or to selected people or groups with view or edit rights.
  580. A restriction is **inherited by child pages**: restricting a parent closes
  581. everything below it, and a child can only narrow that further. The page access
  582. dialog says who restricts a page and who can open it, and the sidebar marks
  583. restricted pages with a lock.
  584. ![Access to a single page](docs/images/page-access.png)
  585. **Getting people in**
  586. - **Invitations by link** with preset spaces and roles, an expiry date and a
  587. usage limit.
  588. - **Access requests.** Someone who opens a space they cannot see can ask for
  589. access; administrators are notified at once and choose the role.
  590. - **Sign-in** with email and password, or through your identity provider (see
  591. below). A new person gets an account and no access until someone grants it,
  592. unless you preset spaces for them.
  593. - **Deactivate** an account without deleting what the person wrote: sessions,
  594. personal tokens and connected apps are cut off at once.
  595. **Sharing outside**
  596. - Share links for people without an account: view or edit, one page or a
  597. whole subtree (pages with their own access restrictions are left out),
  598. revocable at any time. A signed-in reader who can already open the page is
  599. sent to the normal page in their own account (`?as=guest` keeps the guest
  600. view).
  601. - Forms that accept answers without an account.
  602. **For agents and scripts**
  603. - Personal access tokens with `read` or `write` scope, or an OAuth connection
  604. from claude.ai, Claude Desktop or ChatGPT (removable under "Connected apps").
  605. A token never has more rights than its owner, and administrative actions are
  606. not available to tokens at all.
  607. - The `.agent` folder is visible to space administrators only.
  608. **In Slack and Microsoft Teams**
  609. - A pasted Folio link unfurls into a card with the page's title, place, opening
  610. text and headings, built with the access of the person who shared it; a page
  611. they cannot open shows no title at all. [Setup](docs/CHAT-PREVIEWS.md).
  612. ---
  613. ## Groups and single sign-on
  614. Put people in groups, let your identity provider sign them in, and keep both in
  615. sync without anyone doing it by hand.
  616. ![The Folio sign-in page with "Continue with Keycloak" and "Continue with Keycloak (SAML)" buttons above the email and password form](docs/images/sso-login.png)
  617. ![A group's member list in the Access page, with each person marked as coming from OIDC or SAML, a manager checkbox and the group's role in a space](docs/images/groups.png)
  618. ![A page restricted by its parent page: the access dialog says only people who can open the parent can open this one](docs/images/inherited-access.png)
  619. - **Groups.** A named set of people (Engineering, Support, Contractors) that
  620. holds a role in a space or a grant on a restricted page. Give the group a role
  621. once; moving someone in or out changes their access everywhere. A person's
  622. role is the highest of their own and their groups'. Instance administrators
  623. create groups, managers edit the membership, space administrators grant a
  624. group a role in their own space. There is a Groups tab on the Access page, and
  625. groups appear in the matrix, the members dialog, page access and invitations.
  626. - **Single sign-on with OpenID Connect or SAML 2.0.** Keycloak, Authentik,
  627. Microsoft Entra ID, Okta, Google Workspace and any other provider, several at
  628. once, set up at `/admin/auth` or with environment variables, with a "Test
  629. connection" that shows what the provider sends. The sign-in page asks for an
  630. email first and sends your domain to its provider. People can get an account
  631. at first sign-in with preset spaces, or only invited people get in.
  632. - **Make it mandatory.** Switch off password sign-in for your domains; instance
  633. administrators keep an audited emergency sign-in.
  634. - **Groups from the provider.** At every sign-in Folio adds a person to the
  635. Folio groups their provider reports and removes them from the ones it no
  636. longer does. Memberships added by hand are never touched.
  637. - **SCIM 2.0.** Okta, Microsoft Entra ID, Keycloak (with a plugin), OneLogin and
  638. JumpCloud create, update and deactivate people and groups. Deactivating
  639. someone ends all their sessions and tokens at once.
  640. - **Audit log and sessions.** An audit log screen for instance administrators
  641. with filters and a CSV export; everyone sees their signed-in devices and can
  642. sign out the others, and administrators can end a person's sessions.
  643. Setup for each provider is in [docs/INSTALL.md](docs/INSTALL.md#single-sign-on-openid-connect);
  644. what is not covered (LDAP, single logout, encrypted SAML assertions) is in
  645. [docs/LIMITATIONS.md](docs/LIMITATIONS.md).
  646. ---
  647. ## Publish a space as a website
  648. One setting turns a space into a read-only website for people without an
  649. account. Open the space menu, choose **Publish as website** and make the space
  650. public. It is the same space, not a copy: edit a page and the site shows the
  651. change. Signed-in people read a public space the way they read any space that is
  652. open to the instance. Typical uses: a documentation portal built from the
  653. `docs/` folder of a repository (see
  654. [Docs as code, without the IDE](#docs-as-code-without-the-ide)), a public
  655. handbook, a changelog.
  656. <!-- screenshot: public site -->
  657. A short walkthrough: [Publish a space as a public website, with Ask AI for visitors](https://youtu.be/L8Qd4gm_0d4) (1:21).
  658. How the site looks is kept in your repository, not in the database. Open the
  659. space menu, choose **Site & PDF settings…** and one page edits the site title,
  660. description, language, favicon, logo and social image, the site's stylesheet
  661. and the PDF header, footer and print styles. Everything is saved as files in a
  662. `.folio/` folder at the root of the space's content (`site.json`, `site.css`,
  663. `export.css`, `pdf-header.html`, `pdf-footer.html` and `assets/`), one commit
  664. per save, so you can edit the same files in Git too. Search engines get a
  665. `<head>` per page, `robots.txt` and `sitemap.xml`; an "index this site" switch
  666. and a primary address are in the publishing dialog.
  667. | Address | When it works |
  668. |---|---|
  669. | `https://wiki.example.com/public/<space>` | Always, as soon as the space is public. Nothing to set up. |
  670. | `https://<label>.sites.example.com` | When the operator sets `PUBLIC_SITES_DOMAIN=sites.example.com` and the space administrator picks a label. Needs wildcard DNS, a wildcard certificate and a reverse proxy that routes those hosts to Folio. |
  671. | `https://docs.example.com` | A custom domain for one space: a CNAME to the host of your Folio, and the reverse proxy routing that host to Folio, with a certificate for it. |
  672. - **What visitors get.** The page tree, search inside the space, documents,
  673. data tables (live, read-only), whiteboards as pictures, forms (view only) and
  674. PDF and Office files, with breadcrumbs and a layout for phones.
  675. - **Downloads** as Markdown, PDF or DOCX, switched on per space.
  676. - **Ask Folio AI**, switched on per space: visitors ask questions and the
  677. assistant answers in Ask mode only, from the public pages of that one space,
  678. on the key of the space or the instance. It cannot change anything, and
  679. questions are rate limited per address and per site.
  680. - **What is never published.** Pages with their own access restrictions, the
  681. `.agent` folder and templates. A restriction is inherited by child pages, so
  682. locking a page keeps everything below it off the site too.
  683. - **Who can publish.** Space and instance administrators, from the browser. The
  684. decisions (who sees the site, where, downloads, Folio AI, indexing) live in
  685. the database, not in Git; the look of the site lives in `.folio/` in the
  686. repository and is changed by space administrators. In the public demo the
  687. Folio Handbook is published at
  688. <https://demo.foliowiki.online/public/folio-handbook>; you can try the dialog
  689. there (no subdomain, custom domain or Ask), and everything resets daily.
  690. - **Search engines.** Each page carries its own title, description, Open Graph
  691. tags and canonical link, and a page with `unlisted: true` in its front matter
  692. stays out of the sitemap. The public demo is never indexed.
  693. - **Not yet.** There is no PDF preview before saving, `site.css` cannot load
  694. external fonts or images (put them in `.folio/assets/`), and the rate limits
  695. are counted per server process.
  696. What the operator sets up for subdomains and custom domains:
  697. [docs/INSTALL.md](docs/INSTALL.md#public-sites). Limits:
  698. [docs/LIMITATIONS.md](docs/LIMITATIONS.md).
  699. ---
  700. ## Run it
  701. You need [Docker](https://docs.docker.com/get-docker/) and
  702. [Git](https://git-scm.com/downloads). Nothing else.
  703. ```bash
  704. git clone https://github.com/evergreen-it-dev/folio.git
  705. cd folio
  706. docker compose up -d
  707. ```
  708. The first start builds the application and takes a few minutes. Then open
  709. <http://localhost:4870> and create the first account — it becomes the
  710. administrator.
  711. A short welcome takes it from there: pick what to create first — a document,
  712. a whiteboard or a data table — look through what Folio can do, and land in
  713. your first space with that page open. Connecting an existing Git repository
  714. is one link away on the same screen.
  715. ![The welcome screen: what do you want to create first](docs/images/welcome.png)
  716. | Where | How |
  717. |---|---|
  718. | Your computer | `docker compose up -d` |
  719. | A server or VPS | one command from the published image: [`deploy/vps`](deploy/vps/), or the compose file above plus `--profile https` for automatic HTTPS |
  720. | Coolify, Railway, Render, DigitalOcean, Dokploy, CapRover, Easypanel, Portainer, Fly.io | ready-made kits in [`deploy/`](deploy/), see [One-click and PaaS](docs/INSTALL.md#one-click-and-paas) |
  721. | Any other container platform | from the `Dockerfile`, with PostgreSQL, Redis and a persistent volume — see [requirements](docs/INSTALL.md#other-platforms) |
  722. | Vercel, Netlify and other serverless hosting | not supported — Folio is a long-running server that keeps Git repositories on disk and holds live connections |
  723. One click on Railway: [![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/folio)
  724. Domains, HTTPS, updates and backups: [docs/INSTALL.md](docs/INSTALL.md).
  725. **No telemetry.** A Folio you run sends nothing about its use to anyone: no
  726. analytics library is loaded and no connection is opened to the Folio authors or
  727. to a third party. There is one opt-in exception for people who run a public
  728. demo: set `FOLIO_POSTHOG_KEY` to a PostHog project of your own and Folio sends
  729. anonymous events (page kinds, space slugs, never content). Without that key
  730. nothing happens. The same holds for the optional error reporting to a Sentry
  731. project of your own (`SENTRY_DSN`, with a "Report a problem" menu item and an
  732. optional recording of recent actions with all text masked, off with
  733. `SENTRY_REPLAY=0`): no DSN, no library, no connection. Details:
  734. [docs/INSTALL.md](docs/INSTALL.md#optional-analytics-hook-off-by-default) and
  735. [docs/INSTALL.md](docs/INSTALL.md#optional-error-reporting-off-by-default).
  736. ---
  737. ## Documentation
  738. - [Website: foliowiki.online](https://foliowiki.online)
  739. - [Public demo: demo.foliowiki.online](https://demo.foliowiki.online/?utm_source=github&utm_medium=readme&utm_campaign=repo) — shared login, resets every 24 hours
  740. - Free tools, no sign-up: [Confluence to Markdown converter](https://foliowiki.online/tools/confluence-to-markdown/) · [Mermaid live editor](https://foliowiki.online/tools/mermaid-editor/)
  741. - [Markdown templates](https://foliowiki.online/templates/): meeting notes, PRD, SOP, runbook, postmortem, onboarding checklist and more (CC0)
  742. - Alternatives, compared honestly: [Confluence](https://foliowiki.online/alternatives/confluence/) · [Notion](https://foliowiki.online/alternatives/notion/) · [self-hosted wikis](https://foliowiki.online/alternatives/self-hosted-wiki/)
  743. - [Installation, HTTPS, updates, backups](docs/INSTALL.md)
  744. - [Features](docs/FEATURES.md)
  745. - [Docs-as-code without the IDE: edit your repository's docs in a browser](https://foliowiki.online/blog/docs-as-code-in-the-browser/)
  746. - [What is not there yet](docs/LIMITATIONS.md)
  747. - [MCP and REST for agents](docs/MCP.md)
  748. - [Team skills: instructions for agents as wiki pages](docs/TEAM-SKILLS.md)
  749. - [Link previews in Slack and Microsoft Teams](docs/CHAT-PREVIEWS.md)
  750. - [Changelog](CHANGELOG.md)
  751. ## Development
  752. ```bash
  753. cp .env.dev.example .env
  754. docker compose -f docker-compose.dev.yml up -d # PostgreSQL, Redis, MinIO
  755. npm install
  756. npm run dev # http://localhost:4871
  757. ```
  758. Node.js 22.12 or newer (22.13 or newer for the assistant). See
  759. [CONTRIBUTING.md](CONTRIBUTING.md) — and [AGENTS.md](AGENTS.md) if your
  760. contributor is an agent.
  761. ## Help and security
  762. Questions and bug reports: [SUPPORT.md](SUPPORT.md). Please report
  763. vulnerabilities privately, as described in [SECURITY.md](SECURITY.md).
  764. ## License
  765. [MIT](LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

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