Mindex

Your first vault

Open a folder, or make a new one. Everything after that is files.

A vault is a folder. Mindex reads and writes Markdown inside it and keeps its own metadata in one hidden subfolder.

Open or create

  • New vault — ⌘⇧N / Ctrl+Shift+N. Pick an empty folder, or a new one.
  • Open vault — ⌘O / Ctrl+O. Any folder with Markdown in it will do, including one you have been keeping by hand for years.
  • Close vault — ⌘⇧W / Ctrl+Shift+W.

An existing folder needs no conversion step. Mindex indexes what is there and leaves the files as they are.

What appears inside it

One directory, .mindex/, holding the things that are about the vault rather than in it:

Path What it is
.mindex/cache.json The index, rebuilt from the files if deleted
.mindex/settings.json Settings that belong to this vault
.mindex/types/ Note types you created or edited
.mindex/templates/ Your version of the context template

None of it is required to read your notes. Delete the whole directory and the vault still opens; Mindex rebuilds what it can and forgets what it cannot.

Your first note

⌘N / Ctrl+N makes a plain, untyped note. Start typing. Saving happens on its own a moment after you stop; ⌘S just does it now.

To link to another note, type [[ and pick one — see Wiki links.

Then