diff --git a/README.md b/README.md index a8cfb433..d9369253 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ -# OpenKnowledge +

+ + + OpenKnowledge + +

-OpenKnowledge is a beautiful, local-first WYSIWYG markdown editor with integrations for Claude, Codex, and other harnesses. For personal notes, knowledge bases, specs, and LLM wikis. +

+OpenKnowledge is a beautiful WYSIWYG markdown editing app with integrations for Claude, Codex, and other harnesses. For notes, knowledge bases, specs, and LLM wikis. Private, local, and free. +

-
+
+ Site +   •   macOS app   •   - Web App / CLI + Web App + CLI   •   𝕏   •   Discord
+
+ # Features -Key highlights: +Highlights: - Full true **WYSIWYG** so that editing markdown files feels like editing a Google Doc or Notion page. - 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. @@ -29,8 +40,6 @@ Key highlights: - **Embeddable HTML** and rich components for writing engineering specs and visualized reports. - A **built-in TUI** in the Desktop app and a Web UI for users who prefer terminals. -Docs for general usage: . - ## Install **macOS:** download the desktop app — open the DMG, drag **OpenKnowledge** to **Applications**, and launch it. [Latest release](https://github.com/inkeep/open-knowledge/releases/latest). @@ -44,9 +53,21 @@ ok init # scaffold the project + wire up Claude Code, Cursor, and Codex ok start --open # serve the web editor and open it in your browser ``` +## Usage + +Use OpenKnowledge by opening any existing folder on your computer that contains markdown or mdx files. Can be used with existing codebases, wikis, Obsidian vaults, etc. + +Think of it as Notion meets VSCode. + +You can also start from scratch with one of the starter packs, which include e.g. a quickstart for an LLM Wiki. + +The app will automatically initialize your project with MCP and skill configs for agent harnesses detected on your computer. Git sync and sharing can optionally be enabled. + +Docs for general usage: . + ## Contributions -Public pull requests are welcome. When a public PR opens here, automation mirrors it into the internal monorepo for review and merge. +Public pull requests or issues are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for details. @@ -54,6 +75,14 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for details. OpenKnowledge is licensed under the [GNU General Public License v3.0 or later](./LICENSE) (`GPL-3.0-or-later`). +## Support + +Feel free to file an issue or ask questions on the Discord community. +

⭐️ If you'd like to support this project, consider starring the repo ⭐️

+ +

+ Follow us on 𝕏 for product updates. +

diff --git a/assets/hero.webp b/assets/hero.webp index eaf9e1ef..809c6420 100644 Binary files a/assets/hero.webp and b/assets/hero.webp differ diff --git a/assets/ok-wordmark-dark.svg b/assets/ok-wordmark-dark.svg new file mode 100644 index 00000000..46d99848 --- /dev/null +++ b/assets/ok-wordmark-dark.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/ok-wordmark.svg b/assets/ok-wordmark.svg new file mode 100644 index 00000000..93bb3fdb --- /dev/null +++ b/assets/ok-wordmark.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + +