Skip to content

Commit 9d73675

Browse files
committed
document limits
1 parent c7e9c7f commit 9d73675

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

‎docs/insdot.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,11 +609,17 @@ External repositories use a fixed `.` layout: the repository root is the
609609
dotfile directory. For example, `.config/foo/config.toml` in the repo targets
610610
`~/.config/foo/config.toml`.
611611

612+
If your repository keeps dotfiles under another directory, such as
613+
`config/.config/nvim/init.lua`, the automatic external mode will not pick that
614+
up as `~/.config/nvim/init.lua`. Add an `instantdots.toml` file and configure
615+
`dots_dirs = ["config"]` instead.
616+
612617
There are a few limitations:
613618

614619
- Repository metadata is stored in `~/.config/instant/dots.toml`, not in the
615620
repository itself.
616-
- External repositories do not use custom `dots_dirs`.
621+
- External repositories do not use custom `dots_dirs`; use `instantdots.toml`
622+
when you need a custom dotfile root directory.
617623
- Root-owned `_root` layouts are not supported for external repositories.
618624

619625
This is a compatibility layer for existing dotfile repositories, not a full

0 commit comments

Comments
 (0)