Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@
</p>

<p>
<b>OpenKnowledge</b> is a beautiful markdown IDE with a WYSIWYG editor and integrations with Claude, Codex, and other harnesses. For knowledge bases, LLM wikis, specs, and notes. Private, local, and free.
<b>OpenKnowledge</b> is a beautiful markdown editor with integrations with Claude, Codex, and other harnesses. For knowledge bases, LLM wikis, specs, and notes. Private, local, and free.

</p>

<div >
<a href="https://openknowledge.ai">Website</a>
<a href="https://openknowledge.ai">website</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-arm64.dmg">macOS app</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://openknowledge.ai/docs/get-started/quickstart#ok-install-web-app-linux-windows-intel-mac">Web view + CLI</a>
<a href="https://openknowledge.ai/docs/get-started/quickstart#ok-install-web-app-linux-windows-intel-mac">web view + cli</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://x.com/OpenKnowledgeAI">𝕏</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
Expand All @@ -35,7 +35,7 @@

Highlights:
- Full true **WYSIWYG** so that editing markdown files feels like editing a Google Doc or Notion page.
- MacOS app and web UI with file navigator, search, tabs, graph wiki link viewer, and more.
- **macOS app** and **web UI** with file navigator, search, tabs, graph wiki link viewer, and more.
- Collaborative **AI-editing** with **Claude, Codex, and Cursor desktop apps**. Can be used with any harness/agent via MCP/CLI, like OpenCode.
- Out-of-the-box **MCP**, **skills**, and **agentic search** for LLM Wikis, agent second brains, and knowledge graphs.
- No-code **Team sharing** and **Auto-sync** powered by git/GitHub under the hood.
Expand Down
20 changes: 11 additions & 9 deletions docs/content/get-started/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
---
title: Overview
description: A markdown knowledge base your AI coding agents can read and edit, plus a rich editor that opens automatically when they do.
description: Beautiful, AI-native markdown editor.
footer: false
---

OpenKnowledge is a native macOS app for creating and maintaining a portable markdown knowledge base alongside the agents you already use. On Linux, Windows, or an Intel Mac, the same editor runs as a local [web app](/docs/get-started/quickstart#install-the-cli-and-open-the-editor) you launch from the terminal. It works with any MCP-capable agent.
OpenKnowledge is an IDE for co-creating markdown-based knowledge bases and documents with the agents you already use.

<AgentIcons />

Available as a [macOS app](https://github.com/inkeep/open-knowledge/releases/latest/download/OpenKnowledge-arm64.dmg) or a local web app and CLI (for Linux, Windows, and Intel Mac).

## Three layers

OpenKnowledge is three layers working together: a surface you edit, an engine that keeps it consistent, and the files underneath.
OpenKnowledge is three layers working together: a "WYSIWYG" editor for you, MCP and skills for agents, and markdown files underneath.

<LayerStack />

## What you get

- **Rich MDX editing.** Beyond plain markdown, the editor renders Mermaid diagrams, LaTeX math, YouTube, Vimeo, and Loom embeds, an in-browser PDF viewer, interactive HTML and JS previews for charts and custom widgets, callouts, collapsible sections, and live block transclusion. Toggle between WYSIWYG and source modes anytime.
- **First-class AI support, agent-agnostic.** Write collaboratively with the agent of your choice. OpenKnowledge ships the toolset; you bring the agent and the model of your choice.
- **A knowledge base that gets stronger over time.** Reads and writes flow through the OpenKnowledge toolset, so links, backlinks, frontmatter, and asset embeds stay consistent as your knowledge base grows.
- **Track changes with edit-level attribution.** Every edit, human or agent, is recorded on top of git, with per-document version history, point-in-time recovery, and automatic syncing for remote collaboration.
## Additional Features
- "Ask AI" experience for opening your knowledge base in your favorite agent
- No-code **team sharing** and **Auto-sync** powered by git/GitHub under the hood.
- A **built-in TUI** in the desktop app for Claude and Codex
- Graph and wiki link visualizations
- **Embeddable HTML** for writing engineering specs and visualized reports.

## Where to start

Expand Down
23 changes: 11 additions & 12 deletions docs/src/components/overview-blocks.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,24 @@ const LAYERS: Layer[] = [
role: 'What you touch',
desc: (
<>
A beautiful editor for your <code>.md</code> files: WYSIWYG or source mode, backlinks, the{' '}
<code>[[Page]]</code> wiki-link syntax, frontmatter, asset embeds, and version history, with
a live preview as agents work.
A beautiful "what you see is what you get" editor for your markdown files. Supports
interactive HTML and JS, Mermaid diagrams, LaTeX, Videos, PDFs, and more.
</>
),
},
{
k: 'LAYER 02',
Icon: Bot,
title: 'Knowledge Engine',
role: 'The connective layer',
desc: 'Thin MCP wrappers around system functions. Agents read and write through them, so every change automatically carries frontmatter, backlinks, and edit history.',
title: 'Agent tools',
role: 'Knowledge graph',
desc: 'MCP and skills that improve agent search and discovery, and help agents ingest, organize, and maintain knowledge.',
},
{
k: 'LAYER 03',
Icon: Database,
title: 'Content',
role: 'Your source of truth',
desc: 'Plain markdown files in your project, version-controlled in git. No new database, no migration; your knowledge stays portable.',
desc: 'Plain markdown or mdx files in your project, version-controlled in git.',
},
];

Expand Down Expand Up @@ -82,18 +81,18 @@ interface Path {
const PATHS: Path[] = [
{
href: '/docs/get-started/quickstart',
title: 'New to OpenKnowledge? Run the Quickstart',
title: 'Try the Quickstart',
desc: 'Install the desktop app and get your first agent-driven edit in under five minutes.',
},
{
href: '/docs/integrations/claude-code',
title: 'Setting up an editor?',
desc: 'Pick yours from Integrations: Claude, Cursor, Codex, or OpenCode.',
desc: 'Use with Claude, Cursor, Codex, or OpenCode.',
},
{
href: '/docs/reference/mcp',
title: 'Looking up a tool or config field?',
desc: 'Head to the MCP and Configuration reference.',
href: '/docs/workflows/karpathy-llm-wiki',
title: 'Set up an LLM Wiki',
desc: 'Build a Karpathy-style LLM Wiki',
},
];

Expand Down