Official documentation site for Basic Memory - a local-first knowledge management system built on the Model Context Protocol (MCP).

Live Site: docs.basicmemory.com

This repository contains the complete documentation for Basic Memory, including:

• Getting Started guides
• Cloud and Local installation
• MCP Tools Reference
• Integration guides (Claude Desktop, ChatGPT, VS Code, Cursor, Obsidian)
• Knowledge format specification
• CLI Reference
• Release notes

• Framework: Docus (Nuxt-based documentation theme)
• Styling: Tailwind CSS 4 with Nuxt UI
• Content: Markdown with MDC syntax
• Search: Built-in full-text search
• LLM Integration: nuxt-llms for AI-friendly documentation

• Node.js 22+
• npm

# Install dependencies
npm install

# Start dev server
npm run dev

The site will be available at http://localhost:3000

docs.basicmemory.com/
├── app/
│   ├── app.config.ts    # Docus configuration
│   └── components/      # Custom Vue components
├── content/             # Documentation pages (Markdown)
│   ├── 1.start-here/    # Getting started guides
│   ├── 2.whats-new/     # Release notes
│   ├── 3.cloud/         # Cloud documentation
│   ├── 4.local/         # Local installation
│   ├── 5.concepts/      # Core concepts
│   ├── 6.integrations/  # Integration guides
│   ├── 7.how-to/        # How-to guides
│   └── 8.reference/     # Technical reference
├── public/              # Static assets
├── server/              # Server routes (API)
├── nuxt.config.ts       # Nuxt configuration
├── Dockerfile           # Container build
├── fly.toml.template    # Fly.io deployment template
└── justfile             # Development commands

• Factual and clear - No embellishment or marketing language
• Present tense - Describe what features do, not what they will do
• Practical examples - Include working code examples
• Consistent terminology - Use terms as defined in the codebase

1. Create .md file in appropriate directory under content/
2. Use numeric prefixes for ordering (e.g., 1.getting-started.md)
3. Add frontmatter with title and description
4. Use MDC components for callouts and special formatting

Example:

---
title: Page Title
description: Brief description
---

# Page Title

Content here...

::note
Important information for readers
::

::warning
Warning message
::

Docus provides MDC components:

• ::note - General information
• ::warning - Important warnings
• ::tip - Helpful tips
• ::code-group - Tabbed code blocks
• ::card - Card components
• ::steps - Step-by-step instructions

• Development: Auto-deploys on push to main
• Production: Manual deploy via GitHub Actions

# Create Fly.io apps (one-time)
just fly-init development
just fly-init production

# Deploy manually
just deploy development
just deploy production

Requires FLY_API_TOKEN secret configured in repository settings.

just docker-build
just docker-run

• basic-memory - Main Basic Memory repository
• basicmemory.com - Product marketing site
• basicmachines.co - Company website

See the main Basic Memory repository for license information.

• Discord - Community support
• GitHub Issues - Bug reports and feature requests
• Reddit - Community discussions