diff --git a/docs/howto/symlink-dotfiles.md b/docs/howto/symlink-dotfiles.md index 47bf442..bf12068 100644 --- a/docs/howto/symlink-dotfiles.md +++ b/docs/howto/symlink-dotfiles.md @@ -13,8 +13,8 @@ Note that if the dotfile is using template directives, it will be symlinked into `~/.config/dotdrop` instead of directly into your *dotpath* (see [Templating symlinked dotfiles](#templating-symlinked-dotfiles)) -Although the config entries `link_on_import` and `link_dotfile_default` can be set to `link_children`, it -is not recommended since operations on a dotfile that is not a directory with the option `link_children` +Although the config entries `link_on_import` and `link_dotfile_default` can be set to the value `link_children`, +it is not recommended since operations on a dotfile that is not a directory with the option `link_children` will fail. ## Symlink a dotfile diff --git a/docs/templating.md b/docs/templating.md index 975f9c2..18de338 100644 --- a/docs/templating.md +++ b/docs/templating.md @@ -4,6 +4,19 @@ Dotdrop leverage the power of [jinja2](https://palletsprojects.com/p/jinja/) to templating of dotfiles. See [jinja2 template doc](https://jinja.palletsprojects.com/en/2.11.x/templates/) or the below sections for more information on how to template your dotfiles. +## Templating or not templating + +The dotfile config entry [template](config-format.md#dotfiles-entry) +and the global config entry [template_dotfile_default](config-format.md#config-entry) +allow to control if a dotfile is being process by the templating engine. + +Obviously if the dotfile uses template directives, it needs to be templated. However if it +is not, disabling templating will speed up its installation (since it won't have to be +processed by the engine). + +For dotfiles being symlinked (`link` or `link_children`), see +[the dedicated doc](howto/symlink-dotfiles.md#templating-symlinked-dotfiles) + ## Delimiters Dotdrop uses different delimiters than