updated readme, landing page
This commit is contained in:
Gamosoft
parent
eab16aafff
commit
3fff49b84b
36
README.md
36
README.md
|
|
@ -66,6 +66,41 @@ NoteDiscovery is a **lightweight, self-hosted note-taking application** that put
|
|||
- 🕸️ **Graph View** - Interactive visualization of connected notes
|
||||
- ⭐ **Favorites** - Star your most-used notes for instant access
|
||||
- 📑 **Outline Panel** - Navigate headings with click-to-jump TOC
|
||||
- 🤖 **AI Assistant Ready** - MCP integration for Claude, Cursor & more
|
||||
|
||||
## 🤖 AI-Powered Note Management
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/MCP-Compatible-blueviolet?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjIiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCI+PHBhdGggZD0iTTEyIDJhMTAgMTAgMCAxIDAgMTAgMTBIMTJWMnoiLz48cGF0aCBkPSJNMjEuMTggOC44MmMtLjI4LS40LS43Mi0uODItMS4xOC0uODJoLTNjLS40NiAwLS45LjQyLTEuMTguODItLjI4LjQtLjMyLjk4LS4xMiAxLjQybDEuNSAzYy4yLjQ0LjY2LjcgMS4xMi43aDEuMzZjLjQ2IDAgLjkyLS4yNiAxLjEyLS43bDEuNS0zYy4yLS40NC4xNi0xLjAyLS4xMi0xLjQyeiIvPjwvc3ZnPg==" alt="MCP Compatible">
|
||||
<img src="https://img.shields.io/badge/Works%20with-Claude-orange?style=for-the-badge" alt="Works with Claude">
|
||||
<img src="https://img.shields.io/badge/Works%20with-Cursor-blue?style=for-the-badge" alt="Works with Cursor">
|
||||
</p>
|
||||
|
||||
NoteDiscovery includes a built-in **Model Context Protocol (MCP)** server, letting AI assistants directly interact with your notes:
|
||||
|
||||
| What AI Can Do | Example |
|
||||
|----------------|---------|
|
||||
| 🔍 **Search & Discover** | *"Find all my notes about Docker deployment"* |
|
||||
| 📝 **Create & Edit** | *"Create a meeting notes template for tomorrow"* |
|
||||
| 📁 **Organize** | *"Move all project notes to the archive folder"* |
|
||||
| 🏷️ **Tag & Categorize** | *"List all notes tagged with #urgent"* |
|
||||
| 📊 **Explore Connections** | *"Show me the knowledge graph of my notes"* |
|
||||
| ✍️ **Append Ideas** | *"Add this thought to my daily journal"* |
|
||||
|
||||
**One-line setup** for Cursor, Claude Desktop, and other MCP-compatible tools:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"notediscovery": {
|
||||
"command": "docker",
|
||||
"args": ["run", "--rm", "-i", "-e", "NOTEDISCOVERY_URL=http://host.docker.internal:8000", "ghcr.io/gamosoft/notediscovery:latest", "python", "-m", "mcp_server"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> 💡 **See [MCP.md](documentation/MCP.md)** for complete setup instructions and all available tools.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
|
|
@ -211,6 +246,7 @@ Want to learn more?
|
|||
- 📊 **[MERMAID.md](documentation/MERMAID.md)** - Diagram creation with Mermaid (flowcharts, sequence diagrams, and more)
|
||||
- 🔌 **[PLUGINS.md](documentation/PLUGINS.md)** - Plugin system and available plugins
|
||||
- 🌐 **[API.md](documentation/API.md)** - REST API documentation and examples
|
||||
- 🤖 **[MCP.md](documentation/MCP.md)** - AI assistant integration (Claude, Cursor, and more)
|
||||
- 🔐 **[AUTHENTICATION.md](documentation/AUTHENTICATION.md)** - Enable password protection for your instance
|
||||
- 🔧 **[ENVIRONMENT_VARIABLES.md](documentation/ENVIRONMENT_VARIABLES.md)** - Configure settings via environment variables
|
||||
|
||||
|
|
|
|||
|
|
@ -7,8 +7,8 @@
|
|||
<!-- Primary Meta Tags -->
|
||||
<title>NoteDiscovery - Your Self-Hosted Knowledge Base</title>
|
||||
<meta name="title" content="NoteDiscovery - Your Self-Hosted Knowledge Base">
|
||||
<meta name="description" content="A lightweight, privacy-focused Markdown note-taking application with wikilinks, graph view, LaTeX math, Mermaid diagrams, tags, templates, and code highlighting. Self-hosted, free, and open source.">
|
||||
<meta name="keywords" content="note taking, markdown editor, self-hosted, knowledge base, open source, privacy, notes app, docker, second brain, obsidian alternative, notion, evernote, onenote, latex, mermaid, diagrams, math equations, templates, tags, yaml frontmatter">
|
||||
<meta name="description" content="A lightweight, privacy-focused Markdown note-taking application with AI assistant integration (MCP), wikilinks, graph view, LaTeX math, Mermaid diagrams, tags, templates, and code highlighting. Works with Claude, Cursor, and other AI tools. Self-hosted, free, and open source.">
|
||||
<meta name="keywords" content="note taking, markdown editor, self-hosted, knowledge base, open source, privacy, notes app, docker, second brain, obsidian alternative, notion, evernote, onenote, latex, mermaid, diagrams, math equations, templates, tags, yaml frontmatter, AI assistant, MCP, model context protocol, Claude, Cursor, AI notes, AI knowledge base, AI-powered notes">
|
||||
<meta name="author" content="Gamosoft">
|
||||
<meta name="robots" content="index, follow">
|
||||
<link rel="canonical" href="https://www.notediscovery.com">
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
<meta property="og:type" content="website">
|
||||
<meta property="og:url" content="https://www.notediscovery.com">
|
||||
<meta property="og:title" content="NoteDiscovery - Your Self-Hosted Knowledge Base">
|
||||
<meta property="og:description" content="A lightweight, privacy-focused Markdown note-taking application with wikilinks, LaTeX math, Mermaid diagrams, tags, templates, and code highlighting. Self-hosted, free, and open source.">
|
||||
<meta property="og:description" content="AI-powered note-taking with MCP integration for Claude, Cursor & more. LaTeX math, Mermaid diagrams, graph view, wikilinks. Self-hosted, free, and open source.">
|
||||
<meta property="og:image" content="https://www.notediscovery.com/og-image.png">
|
||||
<meta property="og:image:width" content="1200">
|
||||
<meta property="og:image:height" content="630">
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
<meta name="twitter:site" content="@gamosoft">
|
||||
<meta name="twitter:creator" content="@gamosoft">
|
||||
<meta name="twitter:title" content="NoteDiscovery - Your Self-Hosted Knowledge Base">
|
||||
<meta name="twitter:description" content="A lightweight, privacy-focused note-taking application with LaTeX math, Mermaid diagrams, tags, templates, and code highlighting. Self-hosted, free, and open source.">
|
||||
<meta name="twitter:description" content="AI-powered note-taking with MCP integration for Claude & Cursor. LaTeX, Mermaid diagrams, graph view. Self-hosted, free, open source.">
|
||||
<meta name="twitter:image" content="https://www.notediscovery.com/og-image.png">
|
||||
<meta name="twitter:image:alt" content="NoteDiscovery - Self-hosted note-taking application interface">
|
||||
|
||||
|
|
@ -689,7 +689,7 @@
|
|||
<div class="hero animate-on-scroll">
|
||||
<div class="hero-content">
|
||||
<h2>Take Control of Your Notes</h2>
|
||||
<p>A lightweight, privacy-focused note-taking application with powerful features: LaTeX math equations, Mermaid diagrams, smart tags, custom templates, code highlighting, and more. Write, organize, and discover your notes with a beautiful, modern interface—all running on your own server.</p>
|
||||
<p>A lightweight, privacy-focused note-taking application with powerful features: AI assistant integration (MCP), LaTeX math equations, Mermaid diagrams, smart tags, custom templates, code highlighting, and more. Write and organize your notes with a beautiful, modern interface all running on your own server.</p>
|
||||
<div class="cta-buttons">
|
||||
<a href="https://gamosoft-notediscovery-demo.hf.space" class="cta-button demo" target="_blank" rel="noopener">Try Live Demo</a>
|
||||
<a href="https://github.com/gamosoft/NoteDiscovery" class="cta-button" target="_blank" rel="noopener">Get Started on GitHub →</a>
|
||||
|
|
@ -840,6 +840,12 @@
|
|||
<p>No subscriptions, no hidden fees. Free and open source forever.</p>
|
||||
</div>
|
||||
|
||||
<div class="feature animate-on-scroll">
|
||||
<div class="feature-icon">🤖</div>
|
||||
<h3>AI Assistant Ready</h3>
|
||||
<p>MCP integration lets Claude, Cursor & other AI tools search, create, and organize your notes.</p>
|
||||
</div>
|
||||
|
||||
<div class="feature animate-on-scroll">
|
||||
<div class="feature-icon">🧮</div>
|
||||
<h3>LaTeX Math</h3>
|
||||
|
|
@ -912,11 +918,6 @@
|
|||
<p>Progressive Web App (PWA) - install on desktop or mobile for a native experience.</p>
|
||||
</div>
|
||||
|
||||
<div class="feature animate-on-scroll">
|
||||
<div class="feature-icon">🌍</div>
|
||||
<h3>Multi-Language</h3>
|
||||
<p>Built-in translations for English, Spanish, German, and French. Easy to add more.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="benefits animate-on-scroll">
|
||||
|
|
@ -1009,6 +1010,14 @@
|
|||
[[Link notes]] Obsidian-style
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="benefit-item">
|
||||
<span class="emoji">🌍</span>
|
||||
<div class="text">
|
||||
<strong>Multi-Language</strong>
|
||||
English, Spanish, German, French
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -1182,11 +1191,11 @@
|
|||
"@context": "https://schema.org",
|
||||
"@type": "SoftwareApplication",
|
||||
"name": "NoteDiscovery",
|
||||
"description": "A lightweight, Obsidian and Evernote alternative, privacy-focused Markdown note-taking application with LaTeX math, Mermaid diagrams, and code highlighting. Self-hosted, free, and open source.",
|
||||
"description": "A lightweight, AI-powered Markdown note-taking application with MCP integration for Claude, Cursor and other AI assistants. Features LaTeX math, Mermaid diagrams, graph view, and code highlighting. Self-hosted Obsidian and Evernote alternative. Free and open source.",
|
||||
"url": "https://www.notediscovery.com",
|
||||
"applicationCategory": "ProductivityApplication",
|
||||
"operatingSystem": "Linux, Windows, macOS",
|
||||
"featureList": "Markdown editor, Wikilinks, Graph view, LaTeX math equations, Mermaid diagrams, Code syntax highlighting, Dark mode, Plugin system, Internal links, Properties panel, HTML export, Full-text search, Self-hosted, Obsidian, Evernote, Notion, Onenote, Second brain",
|
||||
"featureList": "AI assistant integration, MCP (Model Context Protocol), Claude integration, Cursor integration, Markdown editor, Wikilinks, Graph view, LaTeX math equations, Mermaid diagrams, Code syntax highlighting, Dark mode, Plugin system, Internal links, Properties panel, HTML export, Full-text search, Self-hosted, Obsidian alternative, Evernote alternative, Notion alternative, Second brain, AI-powered notes",
|
||||
"offers": {
|
||||
"@type": "Offer",
|
||||
"price": "0",
|
||||
|
|
|
|||
Loading…
Reference in New Issue