id       = "spacevim"
name     = "SpaceVim"
homepage = "https://spacevim.org/"
# The project's own repository description.
description = "A modular configuration of Vim and Neovim"
# The SpaceVim logo, as the project organisation's avatar: spacevim.org
# declares favicon paths but answers every one of them with the page HTML.
icon     = "https://github.com/SpaceVim.png"
# SpaceVim defines no command a user types — it is loaded by `vim` or `nvim`,
# and the `bin/svc` and `bin/nsvc` wrappers in its checkout are not installed
# onto the PATH — and it is not an application bundle, so it has no bundle
# identifier either. The entry is filed and detected under the project's name,
# the way the other editor distributions in this catalog are (see `janus`).
# Deliberately not `vim` or `nvim`: those map to Vim's and Neovim's own
# entries.
executables   = ["SpaceVim"]

[dotfiles]

# The project's own documentation, in autoload/SpaceVim.vim's help text:
# "All the user configuration files are stored in ~/.SpaceVim.d/ directory",
# whose main file is "`.SpaceVim.d/init.toml` file in your $HOME directory";
# "`~/.SpaceVim.d/` will also be added to 'runtimepath'"; and "It is also
# possible to override the location of `~/.SpaceVim.d/` by using the
# environment variable `$SPACEVIMDIR`". The same file notes that
# `~/.SpaceVim.d/init.vim` is still honoured for users who prefer Vim script.
#
# The whole directory is listed rather than just init.toml, because it is on
# the runtimepath: autoload/, plugin/ and ftplugin/ files a user drops in there
# are loaded as part of their configuration.
paths = ["~/.SpaceVim.d/"]

# Two other trees are deliberately not listed. ~/.SpaceVim is the checkout of
# the distribution itself, which its installer clones and updates from git, and
# the cache is `g:spacevim_data_dir`, set in autoload/SpaceVim.vim to
# `$XDG_CACHE_HOME` when that is set and `$HOME/.cache` otherwise — with the
# downloaded plugins under `g:spacevim_plugin_bundle_dir` inside it. Neither is
# below the path above, so neither needs carving out.
#
# A per-project `.SpaceVim.d/` at the root of a repository is the same idea one
# directory down; it belongs to that repository, not to the home directory.

# A TOML (or Vim script) editor configuration: layers, key bindings, colour
# scheme and options. No credential file.
secret = []

# No machine_lines: the enabled layers, the colorscheme and the key bindings
# are the whole reason to carry the directory. init.toml can name an absolute
# path — a python interpreter for a layer, say — but those keys are per-layer
# and the documentation fixes no stable path for them, so a rule would be a
# guess.