Entry Format Reference

Memex entries are Markdown files with YAML frontmatter.

Basic Structure

---
title: Entry Title
tags: [tag1, tag2, tag3]
created: 2025-01-15
description: One-line summary for search results
---

# Entry Title

Your content here with [[bidirectional links]] to other entries.

Frontmatter Fields

Required

Optional

Bidirectional Links

Link to other entries using wiki-style syntax:

See [[guides/installation]] for setup instructions.

Or use display text: [[guides/installation|the installation guide]].

Link Resolution

Links resolve in this order:

1. Exact path match (with or without .md)
2. Title match (case-insensitive)
3. Filename match (for short links)

Examples

[[guides/installation]]           # Path link
[[Installation Guide]]            # Title link
[[installation]]                  # Filename link
[[guides/installation|Setup]]     # With display text

Tags

Tags enable filtering and discovery:

tags: [infrastructure, deployment, docker]

Best Practices

• Use lowercase, hyphenated tags
• Check existing tags with mx tags
• Be consistent across entries
• Use 2-5 tags per entry

Common Tag Patterns

Content Guidelines

Headings

Use heading hierarchy for structure:

# Main Title (matches frontmatter title)

## Section

### Subsection

Code Blocks

Use fenced code blocks with language hints:

\`\`\`bash
mx search "query"
\`\`\`

\`\`\`python
def example():
    pass
\`\`\`

Lists

Use consistent list formatting:

- Item one
- Item two
  - Nested item

1. First step
2. Second step

File Organization

Categories

Organize entries into directories:

kb/
├── guides/           # How-to guides
├── reference/        # Reference documentation
├── patterns/         # Reusable patterns
├── troubleshooting/  # Problem-solution pairs
├── projects/         # Project-specific docs
└── infrastructure/   # Infrastructure docs

Naming

• Use lowercase with hyphens: my-entry-title.md
• Keep names descriptive but concise
• Avoid special characters

Templates

Use templates for consistent structure:

# List available templates
mx templates

# Create entry from template
mx add --title="..." --tags="..." --category=... --template=troubleshooting

Built-in Templates

See Also

• CLI Reference
• Quick Start Guide