mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-05 05:39:43 +00:00
Code Activity

improve documentation

Browse Source
This commit is contained in:
deadc0de6
2022-06-05 09:19:16 +02:00
committed by deadc0de
parent 3a63941582
commit b8d47144c5
4 changed files with 26 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/config-file.md
View File

@@ -115,15 +115,7 @@ On `update`, the following rule is applied:
## Symlinking dotfiles
Dotdrop is able to install dotfiles in three different ways,
which are controlled by the `link` config attribute of each dotfile:
* `link: nolink`: The dotfile (file or directory) is copied to its destination
* `link: absolute`: The dotfile (file or directory) is linked to its destination using an absolute symlink
* `link: relative`: The dotfile (file or directory) is linked to its destination using a relative symlink
* `link: link_children`: The files/directories found under the dotfile (directory) are symlinked to their destination
For more, see [this how-to](howto/symlink-dotfiles.md).
see the [symlink dotfiles documentation](howto/symlink-dotfiles.md).
## Template config entries

8
docs/howto/howto.md
View File

@@ -36,6 +36,10 @@
[Merge files on install](merge-files-when-installing.md)
## Prompt user for variables
[Prompt user for variables](prompt-user-for-variables.md)
## Share content across dotfiles
[Share content across dotfiles](sharing-content.md)
@@ -43,7 +47,3 @@
## Symlink dotfiles
[Symlink dotfiles](symlink-dotfiles.md)
## Prompt user for variables
[Prompt user for variables](prompt-user-for-variables.md)

13
docs/howto/symlink-dotfiles.md
View File

@@ -1,13 +1,12 @@
# Symlink dotfiles
Dotdrop offers two ways to symlink a dotfile through its
config entry `link`:
Dotdrop is able to install dotfiles in three different ways,
which are controlled by the `link` config attribute of each dotfile:
* Setting `link: absolute` or `link: relative` for a dotfile will symlink `dst` to `src`
* Setting `link: link_children` will, for every direct child of `src`, symlink `dst/<childrenX>` to `src/<childrenX>` (See [Link children](#link-children))
where `src` is the file stored in your *dotpath* and
`dst` is the file located in your `$HOME`.
* `link: nolink`: The dotfile (file or directory) is copied to its destination
* `link: absolute`: The dotfile (file or directory) is linked to its destination using an absolute symlink
* `link: relative`: The dotfile (file or directory) is linked to its destination using a relative symlink
* `link: link_children`: The files/directories found under the dotfile (directory) are symlinked to their destination. For every direct child of `src`, symlink `dst/<childrenX>` to `src/<childrenX>` (See [Link children](#link-children))
Note that if the dotfile uses template directives, it will be symlinked into
`~/.config/dotdrop` instead of directly into your *dotpath*