Skip to content
This repository was archived by the owner on Jun 14, 2026. It is now read-only.

Minion Config File

edthedev edited this page Dec 13, 2014 · 3 revisions

Where to find it.

Minion looks for it's configuration file at ~/.minion.

The configuration file location is the same whether Minion is installed from the command line or as a Vim plugin or both.

What's in it.

Notes Location

The notes home configuration value controls where Minion will place and search for notes. The ~ character, if used, is correctly expanded to point to your home directory.

[notes]
home=~/notes

Using home=~ may cause Minion to become unresponsive, as your music collection is likely a sub-folder of ~, and Minion will search the entire collection every time you open a note. Minion does a search when creating a new note, in order to avoid creating duplicates.

Popular notes home values are:

home=~/Dropbox
home=~/Google Drive
home=~/Box Sync

If you need to search for notes in disparate locations, you may want to set up two separate Minion configurations files and use the --config option to switch between them in different contexts.

I personally use home=/Box Sync at work, and home=/Dropbox at home, and have .zshrc aliases setup for convenient access through separate commands to both.

Composition Defaults

[compose]
editor=gvim
extension=.txt
# templates=~/.minion_templates
templates=~/.vim/bundle/minion/templates 
filename_sep=-

Editor controls which program on your computer is invoked when a Minion command results in opening a text file on the command line. Minion will instead use sensible defaults for non-text files such as PDF and HTML files.

Extension controls the file extension added to newly created notes. Common preferences are .txt and .md.

Templates controls the location of the Minion template files used for the 'minion template' command. To add a new template called foo, add a file to this folder called foo_template.txt. If it's awesome, please send it to me to share with other Minion users. :)

Minion avoids using spaces in new file names as spaces in filenames introduce unnecessary ambiguity, both technical and logistical. The filename_sep settings controls what character will be used to replace spaces when note titles are converted into filenames.

Clone this wiki locally