# OpenKnowledge

> Beautiful, AI-native markdown editor for humans and agents. Build knowledge bases, LLM wikis, and agent 2nd brains.

Every link below is the Markdown rendition of a page. Each rendition names the page a reader would open in its first heading and in its `Link: rel="canonical"` header; that is the URL to cite. Each of those pages also serves this same Markdown from its own URL to any request sending `Accept: text/markdown`.

## Docs

- [Folders and templates](https://openknowledge.ai/docs/advanced/folders-and-templates.md): Describe a folder with its own properties, and offer reusable templates that give new documents their starting content and properties.
- [Translate the interface](https://openknowledge.ai/docs/contribute/translations.md): Community driven translations
- [Agent activity](https://openknowledge.ai/docs/features/agent-activity.md): See every file an agent edits in a session, with per-edit diffs and selective rollback.
- [Assets and embeds](https://openknowledge.ai/docs/features/assets-and-embeds.md): Drop files into the editor and reference them with wiki-style embeds.
- [Comments](https://openknowledge.ai/docs/features/comments.md): Annotate your knowledge base with comments and resolve them with your agent
- [Editor](https://openknowledge.ai/docs/features/editor.md): The OpenKnowledge editor. WYSIWYG markdown, source toggle, content blocks, link authoring, inline frontmatter, and the file sidebar.
- [Ignore patterns](https://openknowledge.ai/docs/features/ignore-patterns.md): Hide files and folders from search and your AI agents.
- [Share links](https://openknowledge.ai/docs/features/share.md): Copy a link to any doc or folder and send it to a teammate. OpenKnowledge handles the GitHub round-trip, the deep link, and the branch on the other end.
- [Timeline and recovery](https://openknowledge.ai/docs/features/timeline-and-recovery.md): Review the edit history for the open document, including agent, human, upstream sync, and file system changes, with inline diffs and version restore.
- [Overview](https://openknowledge.ai/docs/get-started/overview.md): Beautiful, AI-native markdown editor for humans and agents. Build knowledge bases, LLM wikis, and agent 2nd brains.
- [Quickstart](https://openknowledge.ai/docs/get-started/quickstart.md): Set up a knowledge base with OpenKnowledge in less than five minutes.
- [Antigravity](https://openknowledge.ai/docs/integrations/antigravity.md): Use OpenKnowledge with Antigravity.
- [Claude](https://openknowledge.ai/docs/integrations/claude-code.md): Use OpenKnowledge with Claude Code, in the CLI or the Claude Desktop app.
- [Codex](https://openknowledge.ai/docs/integrations/codex.md): Use OpenKnowledge with Codex.
- [Cursor](https://openknowledge.ai/docs/integrations/cursor.md): Use OpenKnowledge with Cursor.
- [GitHub Copilot CLI](https://openknowledge.ai/docs/integrations/github-copilot-cli.md): Use OpenKnowledge with GitHub Copilot CLI.
- [Hermes](https://openknowledge.ai/docs/integrations/hermes.md): Use OpenKnowledge with Hermes Agent.
- [LM Studio](https://openknowledge.ai/docs/integrations/lm-studio.md): Use OpenKnowledge with LM Studio.
- [OpenClaw](https://openknowledge.ai/docs/integrations/openclaw.md): Use OpenKnowledge with OpenClaw.
- [OpenCode](https://openknowledge.ai/docs/integrations/opencode.md): Use OpenKnowledge with OpenCode.
- [Pi](https://openknowledge.ai/docs/integrations/pi.md): Use OpenKnowledge with Pi.
- [From Notion](https://openknowledge.ai/docs/migrate/notion.md): How to export a Notion workspace to Markdown and open it in OpenKnowledge, what carries over, and where the two differ.
- [From Obsidian](https://openknowledge.ai/docs/migrate/obsidian.md): How to open an existing Obsidian vault in OpenKnowledge, which markdown syntax carries over, and where the two differ.
- [OKF](https://openknowledge.ai/docs/plugins/okf.md): Keep a project portable to Google's Open Knowledge Format with advisory rules, agent-readable schemas, an optional index generator, and a companion skill.
- [Overview](https://openknowledge.ai/docs/plugins/overview.md): Optional capabilities that ship with OpenKnowledge, most of them off until you turn them on. Linters, OKF portability, themes, and presentations.
- [Slidev](https://openknowledge.ai/docs/plugins/slidev.md): Present a markdown document as a slide deck in its own window, rendered by the Slidev CLI.
- [Themes](https://openknowledge.ai/docs/plugins/themes.md): Recolor the editor with built-in palettes or your own base16 schemes, one palette per light mode and one per dark, saved as portable YAML files.
- [Agentic search](https://openknowledge.ai/docs/reference/agentic-search.md): How an agent finds things with no vector database: it searches, greps, and follows backlinks in a loop over live files that come back with their graph context attached, not a vector copy.
- [CLI & web app](https://openknowledge.ai/docs/reference/cli.md): Install the ok CLI and run the OpenKnowledge web app in your browser — on any platform, including Intel Macs and servers.
- [Configuration](https://openknowledge.ai/docs/reference/configuration.md): The .ok/config.yml schema and environment variables.
- [Core Concepts](https://openknowledge.ai/docs/reference/core-concepts.md): How OpenKnowledge works: the three-layer model, the file system as the database, links and backlinks, the well-connected knowledge base, and attribution.
- [MCP](https://openknowledge.ai/docs/reference/mcp.md): Tools the OpenKnowledge MCP server exposes to AI agents.
- [What OpenKnowledge writes to your system](https://openknowledge.ai/docs/reference/what-open-knowledge-writes.md): Every file OpenKnowledge creates or changes — when, where, in-project vs. your home directory — plus the opt-outs and what leaves your machine (nothing by default).
- [Authentication](https://openknowledge.ai/docs/remote-control/authentication.md): Control who can reach your knowledge base.
- [Connect remote agents](https://openknowledge.ai/docs/remote-control/connecting-agents.md): Connect agents running on another machine or in the cloud to your OpenKnowledge project.
- [Overview](https://openknowledge.ai/docs/remote-control/overview.md): Set up remote access to your OpenKnowledge server.
- [Codebase wiki](https://openknowledge.ai/docs/workflows/codebase-wiki.md): An AI reads your code and writes a plain-English guide to it: how it's built, how the pieces fit, with diagrams and links back to the real files. The guide lives right in your repo, stays private, and helps the next person (or AI) get up to speed fast. Built on the Codebase wiki starter pack.
- [Entity vault (GBrain-compatible) workflow](https://openknowledge.ai/docs/workflows/entity-vault.md): A personal memory for the people, companies, and meetings in your world. Each one gets its own page that an AI keeps up to date as you learn more, and you can correct anything by hand. Works with Garry Tan's gbrain if you use it, but doesn't need it.
- [LLM wiki](https://openknowledge.ai/docs/workflows/karpathy-llm-wiki.md): Point an AI at a folder of your own notes and let it keep them organized, linked, and easy to search. The more you add, the tidier it gets instead of messier. Built on the Knowledge base starter pack.
- [Ingest meetings](https://openknowledge.ai/docs/workflows/meeting-ingestion.md): Get meeting transcripts into your knowledge base as markdown, where they are searchable, linkable, and answerable. OpenKnowledge does not record meetings. You bring a recorder, OK holds the result.
- [Plain notes](https://openknowledge.ai/docs/workflows/plain-notes.md): The simplest setup: one folder for notes and one for a daily journal. Just write, link the things worth linking, and a connected web of notes builds itself. Built on the Plain notes starter pack.
- [Software lifecycle](https://openknowledge.ai/docs/workflows/software-lifecycle.md): One home for the docs an engineering team writes around its code: the pitch for a change, the decision that settles it, the plan to build it, and the write-up when something breaks. Each links to the next, and an AI keeps the connections current. Built on the Software lifecycle starter pack.
- [Supporting the Open Knowledge Format](https://openknowledge.ai/docs/workflows/supporting-open-knowledge-format.md): Start with a small OKF v0.2 knowledge base, keep it portable as it grows, and give agents the format guidance they need.
- [Worldbuilding](https://openknowledge.ai/docs/workflows/worldbuilding.md): A living encyclopedia for a story you're writing: characters, places, factions, and lore, each on its own page that links to the others. Mention someone new and the AI adds a page for them; contradict your own canon and it flags it. Built on the Worldbuilding starter pack.
- [Writing pipeline](https://openknowledge.ai/docs/workflows/writing-pipeline.md): Three folders that move a piece of writing from idea to published: catch ideas before they slip away, draft with an AI while every revision is saved automatically, and leave finished pieces untouched. Built on the Writing pipeline starter pack.
- [Frontmatter schemas](https://openknowledge.ai/docs/advanced/content-rules/frontmatter.md): Validate document frontmatter against standard JSON Schema files — scoped to folders with globs, with schema-driven selects in the property panel and a no-code schema editor.
- [markdownlint](https://openknowledge.ai/docs/advanced/content-rules/markdownlint.md): The markdownlint linter for content rules — VS Code-parity defaults, your project's native `.markdownlint.*` config, and a no-code browser for all 53 rules.
- [Overview](https://openknowledge.ai/docs/advanced/content-rules/overview.md): A non-blocking linting layer over your project's markdown — problems as you write, a Problems panel, `ok lint` for CI, and advisories for AI agents. Enable it per project.
- [GitHub](https://openknowledge.ai/docs/features/git/github.md): Clone and publish GitHub repositories.
- [Git sync](https://openknowledge.ai/docs/features/git/sync.md): Auto-sync changes with your team and resolve conflicts.
- [Skills OpenKnowledge ships](https://openknowledge.ai/docs/features/skills/built-in-skills.md): What each built-in skill does, and how to install or remove it.
- [Find and install skills](https://openknowledge.ai/docs/features/skills/find-and-install.md): Find a skill, read what it does, and choose the AI tools that can use it.
- [Share skills with your team](https://openknowledge.ai/docs/features/skills/for-teams.md): Set up the repository your team installs skills from.
- [Skills Studio](https://openknowledge.ai/docs/features/skills.md): Reusable instructions for the way you work.
- [Install your team's skills](https://openknowledge.ai/docs/features/skills/install-team-skills.md): Add your team's skill repository and install the skills you want, in about a minute.
- [Developer reference](https://openknowledge.ai/docs/features/skills/reference.md): Skill file layout, install locations, CLI commands, MCP tools, and sidebar configuration.
- [Symlink skills](https://openknowledge.ai/docs/features/skills/symlink-skills.md): Point one AI tool's skills folder at another so both read the same skills.
- [Distribute as a plugin](https://openknowledge.ai/docs/features/skills/team-plugins.md): When packaging your team's skills as a plugin is the better choice, and what you give up.
- [Keep team skills current](https://openknowledge.ai/docs/features/skills/team-updates.md): How a change to a team skill reaches everyone, and what happens to one somebody adapted.
- [Write a skill](https://openknowledge.ai/docs/features/skills/write-a-skill.md): Turn a task you repeat into instructions your AI tools can follow.
- [Accordion](https://openknowledge.ai/docs/reference/components/accordion.md): Standalone expand/collapse via native HTML5 \<details>/\<summary>. Group siblings with the `name` prop for exclusive-accordion UX
- [Audio](https://openknowledge.ai/docs/reference/components/audio.md): HTML5 audio player with native controls
- [Callout](https://openknowledge.ai/docs/reference/components/callout.md): Alert / admonition with 15 type variants — 5 GFM (note, tip, important, warning, caution) plus 10 Obsidian-parity (abstract, info, todo, success, question, failure, danger, bug, example, quote)
- [Embed](https://openknowledge.ai/docs/reference/components/embed.md): Inline web embed (iframe) — drop a URL, get a resizable preview pane. For YouTube / Vimeo / Loom prefer `<video src="…">` (player props, click-facade); `<Embed>` auto-rewrites watch URLs as a fallback
- [Excalidraw](https://openknowledge.ai/docs/reference/components/excalidraw.md): Embedded snapshot of an `.excalidraw` board, linking to its canvas editor
- [File](https://openknowledge.ai/docs/reference/components/file.md): Downloadable file attachment — inline row with name + size + download link
- [Align block](https://openknowledge.ai/docs/reference/components/html-align-block.md): GitHub-style `<div align>` wrapper. Children render as normal blocks with the alignment applied; the `<div align>` syntax is preserved on round-trip
- [Image](https://openknowledge.ai/docs/reference/components/img.md): Image with click-to-zoom and HTML-native attributes
- [Overview](https://openknowledge.ai/docs/reference/components.md): The rich content blocks the OpenKnowledge editor understands — callouts, media, math, mermaid diagrams, accordions, tabs, and transclusion.
- [Math](https://openknowledge.ai/docs/reference/components/math.md): Block math equation rendered with KaTeX from a LaTeX source string
- [Mermaid](https://openknowledge.ai/docs/reference/components/mermaid-fence.md): Diagram rendered from Mermaid source (flowchart, sequence, class, state, ER, gantt, pie). Authored exclusively as ` ```mermaid ` fenced code
- [Mirror](https://openknowledge.ai/docs/reference/components/mirror.md): Render a read-only copy of a `<MirrorSource>` block from another doc. Use to keep the same content in sync across multiple docs without copy-paste — edits land at the source, every Mirror reflects the change
- [PDF](https://openknowledge.ai/docs/reference/components/pdf.md): Embedded PDF viewer (`#page=N` to open at page N, `#height=N` for viewer height)
- [Tabs](https://openknowledge.ai/docs/reference/components/tabs.md): Horizontal tab strip + active panel below. Each `<Tab>` child is one panel; clickable pills at the top switch the active one. Active selection is ephemeral (resets on reload)
- [Toggle](https://openknowledge.ai/docs/reference/components/toggle.md): Standalone expand/collapse block (Notion-style). Same render + props as `<Accordion>` — pick whichever vocabulary matches the vault
- [Video](https://openknowledge.ai/docs/reference/components/video.md): HTML5 video player with native controls
- [CLI](https://openknowledge.ai/docs/remote-control/methods/cli.md): Run OpenKnowledge with the CLI on your computer, a VM, or a server.
- [Docker](https://openknowledge.ai/docs/remote-control/methods/docker.md): Build the OpenKnowledge container image and run it on Railway, Fly.io, or any Docker host.

## Blog

- [Blog index](https://openknowledge.ai/blog.md): Every published post with its title, date, and summary.
- [Open Knowledge Format plugin for LLM wikis](https://openknowledge.ai/blog/open-knowledge-format-okf-plugin-linter.md): The new OKF plugin helps you write and maintain knowledge bases and LLM wikis that comply with Google's Open Knowledge Format.
- [Open any markdown file anywhere](https://openknowledge.ai/blog/open-any-markdown-file-anywhere.md): Use OpenKnowledge as the go-to editor for any markdown file on your device and enjoy new IDE capabilities.
- [Native Integrations with any agent via ACP](https://openknowledge.ai/blog/native-integrations-with-any-agent-via-acp.md): Chat with any of 30+ agents within OpenKnowledge with a new native chat and comments UI.
- [Linux & Windows Apps + Remote Control](https://openknowledge.ai/blog/apps-for-linux-windows-and-remote-control.md): OpenKnowledge now ships desktop apps for Linux and Windows, and Remote Control lets you reach your knowledge base from any device or agent.
- [Edit Mermaid diagrams visually with Visimer](https://openknowledge.ai/blog/edit-mermaid-diagrams-visually.md): Edit Mermaid diagrams visually with Visimer, the open source library that powers the Mermaid editing experience in OpenKnowledge.
- [Keeping you and your agents in check with markdownlint](https://openknowledge.ai/blog/markdownlint-support.md): Native markdownlint support in Open Knowledge: your existing config works as-is, a GUI builds one if you don't have it, and your agents see the same rules you do.

## Product

- [OpenKnowledge](https://openknowledge.ai/index.md): What it is, how to get it, and where everything else lives.
- [Download](https://openknowledge.ai/download.md): Direct installer URLs for every macOS, Windows, and Linux build.
- [Team](https://openknowledge.ai/team.md): Who builds OpenKnowledge, and the rendition of each profile.
- [Brand](https://openknowledge.ai/brand.md): Logo and icon files, and the rules for using them.