Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

docs: hero lossless WebP via picture, repoint CLI links to quickstart (#2132)

Nick Gomezf96f52328726
diff --git a/README.md b/README.md
index 2d1f867ab..6b9ecc367 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,17 @@
OpenKnowledge is a beautiful, local-first markdown editor and LLM wiki with integrations for Claude, Codex, and Cursor.
-<img
- src="assets/hero.gif"
- alt="OpenKnowledge editor with an AI agent drafting a launch recap"
- width="100%"
- style="border-radius: 10px"
-/>
-
-Available as [macOS app](https://github.com/inkeep/open-knowledge/releases/latest/download/Open-Knowledge-arm64.dmg) or [Web app/CLI](https://openknowledge.ai/docs/reference/cli).
+<picture>
+ <source srcset="assets/hero.webp" type="image/webp" />
+ <img
+ src="assets/hero.gif"
+ alt="OpenKnowledge editor with an AI agent drafting a launch recap"
+ width="100%"
+ style="border-radius: 10px"
+ />
+</picture>
+
+Available as [macOS app](https://github.com/inkeep/open-knowledge/releases/latest/download/Open-Knowledge-arm64.dmg) or [Web app/CLI](https://openknowledge.ai/docs/get-started/quickstart#ok-install-web-app-linux-intel-mac) for Windows and Linux.
# Features
@@ -26,13 +29,13 @@ Docs for general usage: <https://openknowledge.ai/docs>.
**macOS:** download the desktop app — open the DMG, drag **Open Knowledge** to **Applications**, and launch it. [Latest release](https://github.com/inkeep/open-knowledge/releases/latest).
-**Linux or an Intel Mac:** run the same editor as a local web app via the CLI (Windows isn't supported yet) ([Node.js 24+](https://nodejs.org) required):
+**Linux, Windows, or Intel Mac:** run the same editor as a local web app via the CLI ([Node.js 24+](https://nodejs.org) required):
```bash
npm install -g @inkeep/open-knowledge
cd your-project
ok init # scaffold the project + wire up Claude Code, Cursor, and Codex
-ok start --open # serve the editor and open it in your browser
+ok start --open # serve the web editor and open it in your browser
```
## Contributions
diff --git a/assets/hero.webp b/assets/hero.webp
new file mode 100644
index 000000000..7cb934165
Binary files /dev/null and b/assets/hero.webp differ
diff --git a/docs/content/get-started/overview.mdx b/docs/content/get-started/overview.mdx
index 0eb071681..3e55c9db0 100644
--- a/docs/content/get-started/overview.mdx
+++ b/docs/content/get-started/overview.mdx
@@ -4,7 +4,7 @@ description: A markdown knowledge base your AI coding agents can read and edit,
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 or an Intel Mac, the same editor runs as a local [web app](/docs/reference/cli) you launch from the terminal. It works with any MCP-capable agent.
+OpenKnowledge is a native macOS app for creating and maintaining a portable markdown knowledge base alongside the agents you already use. On Linux or an Intel Mac, the same editor runs as a local [web app](/docs/get-started/quickstart#ok-install-web-app-linux-intel-mac) you launch from the terminal. It works with any MCP-capable agent.
<AgentIcons />
diff --git a/docs/src/app/(home)/sections/call-to-action.tsx b/docs/src/app/(home)/sections/call-to-action.tsx
index 0c6a09291..ab166e788 100644
--- a/docs/src/app/(home)/sections/call-to-action.tsx
+++ b/docs/src/app/(home)/sections/call-to-action.tsx
@@ -113,7 +113,7 @@ export function CallToAction() {
Download for macOS
</MarketingButton>
<Link
- href="/docs/reference/cli"
+ href="/docs/get-started/quickstart#ok-install-web-app-linux-intel-mac"
className="font-mono text-base text-slide-muted underline-offset-4 transition-colors hover:text-slide-text hover:underline"
>
or CLI
diff --git a/docs/src/app/(home)/sections/hero.tsx b/docs/src/app/(home)/sections/hero.tsx
index 015f2f66b..c2f9baa8e 100644
--- a/docs/src/app/(home)/sections/hero.tsx
+++ b/docs/src/app/(home)/sections/hero.tsx
@@ -55,7 +55,7 @@ export function Hero() {
Download for macOS
</MarketingButton>
<Link
- href="/docs/reference/cli"
+ href="/docs/get-started/quickstart#ok-install-web-app-linux-intel-mac"
className="font-mono text-sm text-slide-muted underline-offset-4 transition-colors hover:text-slide-text hover:underline"
>
or CLI
diff --git a/docs/src/components/mcp-install.tsx b/docs/src/components/mcp-install.tsx
index c9a7f8cbd..54c8ad971 100644
--- a/docs/src/components/mcp-install.tsx
+++ b/docs/src/components/mcp-install.tsx
@@ -12,9 +12,12 @@ export function McpInstall({ editor, children }: { editor: string; children?: Re
</li>
<li>
<strong>Web app / terminal</strong> (Linux, Intel Mac — see the{' '}
- <a href="/docs/reference/cli">web app guide</a>). Run <code>ok init</code> in your
- project: it registers the OpenKnowledge MCP server with {editor} and the other editors it
- detects. Every <code>ok start</code> refreshes the entry.
+ <a href="/docs/get-started/quickstart#ok-install-web-app-linux-intel-mac">
+ web app guide
+ </a>
+ ). Run <code>ok init</code> in your project: it registers the OpenKnowledge MCP server
+ with {editor} and the other editors it detects. Every <code>ok start</code> refreshes the
+ entry.
</li>
</ul>
{children}