# Markdown and Obsidian (/en/docs/markdown)

Your notes already hold your plans, meeting records and decisions. Add your notes folder or Obsidian vault to Memo,
and your AI agent can search them on your computer, next to your chats, mail and meetings. Memo reads the files and
never changes them.

An agent with access to your notes finds the note where a decision was written down, quotes the line, and shows the
notes that link to it. It can also write a new note about a person or a project for you, and save your notes as
Markdown files again.

There is no separate Markdown tool: `memo` reads folders of notes. You need `memo` installed
([installation](/llms.mdx/docs/memo/installation/content.md)). It needs no account and no sign-in: your notes are already on your computer.

**On this page:**

1. [Short version](#short-version)
2. [Markdown folder or Obsidian vault](#markdown-folder-or-obsidian-vault)
3. [What your agent tells you](#what-your-agent-tells-you)
4. [Files Memo can read](#files-memo-can-read)
5. [Keep your notes up to date](#keep-your-notes-up-to-date)
6. [Write notes and save them as files](#write-notes-and-save-them-as-files)
7. [If a note is missing](#if-a-note-is-missing)

## Short version [#short-version]

The examples use the folder `~/Notes`, a notes folder in your home folder. Use the path of yours.

```sh
memo folders add ~/Notes
memo sync --only notes --no-embed
memo search notes 'budget'
```

The first command adds the folder and prints its ID, for example `1`. The sync reads every file in the folder and in
the folders inside it, and reports how many notes it found. The search shows each matching file and its first
matching line.

`--no-embed` skips the preparation for search by meaning, so you can start without the search model. Leave it out
once you have the model, and the agent also finds a note by what it means.

Or ask your agent:

```text prompt
Use memo CLI to add my notes folder at ~/Notes and import it.
Tell me how many notes it found and which files it could not read.
```

## Markdown folder or Obsidian vault [#markdown-folder-or-obsidian-vault]

Memo reads any folder of Markdown files. An Obsidian vault is a folder of Markdown notes that Obsidian opens as one
workspace. Memo finds out which one you have: a folder with Obsidian's own `.obsidian` folder in it, or in a folder
above it, is read as a vault. You do not need Obsidian to use Memo, and Obsidian does not need to be open.

The two differ in how links and tags are written:

| | Markdown folder | Obsidian vault |
|---|---|---|
| Links to other notes | `[label](other-note.md)` | `[[Other note]]` and `[[Other note\|label]]` |
| Tags | the `tags:` field at the top of the file | the `tags:` field and `#tags` in the text |
| Other names for a note | | the `aliases:` field |

To choose the format yourself, add `--format markdown` or `--format obsidian` to `memo folders add`. Memo skips
hidden folders such as `.obsidian`.

## What your agent tells you [#what-your-agent-tells-you]

Ask in your own words:

```text prompt
Use memo CLI. Find the note where we decided the Harbour budget. Quote the line with the file name,
and list the notes that link to it.
```

To find a note together with your messages, mail and meetings, the agent runs `search all`:

```sh
memo search all 'Harbour budget'
memo notes show document:3
```

`notes show` opens one note with its tags, the notes it links to and the notes that link to it. A note from a file
has a reference such as `document:3`. Copy it from a search result.

A useful answer names the file and quotes the line. An empty answer does not prove that the note does not exist: see
[If a note is missing](#if-a-note-is-missing).

## Files Memo can read [#files-memo-can-read]

A folder can hold more than Markdown. Memo reads these files too:

| Files | Extensions | What Memo keeps |
|---|---|---|
| Text and Markdown | `.txt`, `.md`, `.markdown` | The text, links and tags |
| Tables | `.csv`, `.tsv`, `.xlsx`, `.ods` | Cell values, with the sheet, row and column |
| Documents, slides and e-books | `.odt`, `.pptx`, `.epub` | The text, without the layout |
| PDF and Word | `.pdf`, `.docx`, `.doc` | The text, with PDF page numbers |
| Web pages saved as files | `.html`, `.htm` | The page's main text and title |

Memo cannot read scanned PDFs (pictures of pages, with no text in them), old `.xls` files and files larger than
50 MiB. It keeps up to 200,000 characters of each file.

## Keep your notes up to date [#keep-your-notes-up-to-date]

Run the sync again after you add or edit files. Only the changes are read:

```sh
memo sync --only notes
```

To sync on a timer, for example every ten minutes:

```sh
memo jobs start --every 10m
```

You can add more than one folder. `memo folders list` shows them all. A folder inside or around one Memo already
reads is refused, because each shared file would then be two notes.

To keep some files out, list them under `notes.ignore` in the [config file](/llms.mdx/docs/memo/configuration/content.md#notes). A rule
is a path inside the folder, a folder or a pattern:

```json
{ "notes": { "ignore": ["Journal/Private.md", "Archive", "**/Private*"] } }
```

## Write notes and save them as files [#write-notes-and-save-them-as-files]

Your agent can also write a note in Memo about a person, a message, a project or another note. Writing it sends
nothing to anyone.

```sh
memo notes add 'Prefers morning meetings' --subject telegram:'Kai Sample'
```

To keep these notes in your vault too, export them as Markdown files:

```sh
memo notes export --output-dir ~/Notes/memo --format obsidian
```

Use `--format markdown` for plain Markdown. Each file gets a `memo-id` and a `memo-hash` at the top, so importing
that folder does not create the same note twice. If you edited an exported file yourself, Memo does not overwrite it
and tells you.

A note from your own files is edited in the file, not in Memo. Edit it as usual and run the sync again.

## If a note is missing [#if-a-note-is-missing]

1. **The file is new or changed.** Run `memo sync --only notes` again.
2. **The file was not read.** The sync report lists every file it could not read, and why, on every run until the
   file changes:

   ```text
   notes /home/you/Notes: 41 notes, 2 changed, 0 moved, 0 gone, 1 not read
     not read: Archive/2009 budget.xls — this file type cannot be read
   ```

3. **A link or a tag is not found.** The folder may be read in the other format. Find its ID with
   `memo folders list`, then set the format: `memo folders update 1 ~/Notes --format obsidian`. The next sync
   reads every note of that folder again.
4. **A search by meaning finds nothing.** The search model is not downloaded, or the sync ran with `--no-embed`.
   Search by words, or download the model as the [installation](/llms.mdx/docs/memo/installation/content.md) says.

More about notes, folders and links to people is in [Notes and folders](/llms.mdx/docs/memo/notes/content.md). Next: [label your notes
with tags](/llms.mdx/docs/memo/tags/content.md), or [search them](/llms.mdx/docs/memo/search/content.md).
